Pop CLI

Installation

Quick Install (Recommended)

Using cargo-binstall (cross-platform - downloads pre-built binaries when available):

# Install cargo-binstall if you don't have it
curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash

# Install pop-cli
cargo binstall pop-cli --locked

macOS

Using Homebrew:

brew install r0gue-io/pop-cli/pop

Linux

Using Ubuntu PPA:

sudo add-apt-repository ppa:r0gue-io/pop
sudo apt-get update
sudo apt-get install pop-cli

:information_source: If add-apt-repository is not found, install it with sudo apt-get install software-properties-common.

Using Homebrew:

brew install r0gue-io/pop-cli/pop

Debian/Ubuntu (using .deb package from releases):

sudo dpkg -i pop-cli_*.deb

Nix/NixOS:

# Run directly without installing
nix run github:r0gue-io/pop-cli

# Or install to your profile
nix profile install github:r0gue-io/pop-cli

For NixOS configuration:

{
  inputs.pop-cli.url = "github:r0gue-io/pop-cli";
  # ...
  environment.systemPackages = [ inputs.pop-cli.packages.${system}.default ];
}

From Source

From crates.io (compiles from source):

cargo install --locked pop-cli

From GitHub (latest development version):

cargo install --locked --git https://github.com/r0gue-io/pop-cli

Requirements

:information_source: Pop CLI requires Rust 1.91.1 or later.

:information_source: For detailed instructions on how to install Pop CLI, please refer to our documentation: https://learn.onpop.io/v/cli/installing-pop-cli

Telemetry

Pop CLI collects anonymous usage metrics to help us understand how the tool is being used and how we can improve it. We do not collect any personal information. If you wish to disable telemetry or read more about our telemetry practices please see our telemetry documentation.

Documentation

On the Pop Docs website you will find:

• 👉 Get Started with Pop CLI

Building Pop CLI locally

Build with default features (parachain support):

cargo build

Build with Smart Contracts support (opt-in):

cargo build --features contract

Build for parachain functionality only:

cargo build --no-default-features --features chain

Build for Smart Contracts functionality only:

cargo build --no-default-features --features contract

:information_source: Smart contract (ink!) support is available as an opt-in feature. To install with contract support: cargo install pop-cli --locked --features contract

Testing Pop CLI

To test the tool locally. Due to the time it can take to build a Parachain or a Smart Contract, some tests have been separated from the normal testing flow into integration tests.

We use cargo nextest for faster test runs.

cargo install cargo-nextest

Run the unit tests only:

# Recommended
cargo nextest run --lib --bins
# If you don't have nextest installed
cargo test --lib --bins

To run the integration tests relating to Smart Contracts:

cargo nextest run --no-default-features --features contract --test contract

To run the integration tests relating to Parachains:

cargo nextest run --no-default-features --features chain --test chain
cargo nextest run --no-default-features --features chain --test metadata

Run all tests (unit + integration):

cargo nextest run

Running tests may result in rate limits being exhausted due to the reliance on the GitHub REST API for determining releases. As per https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api#getting-a-higher-rate-limit, a personal access token can be used via the GITHUB_TOKEN environment variable.

Security/advisory checks

We use cargo-deny locally to check advisories and licenses.

cargo install cargo-deny
cargo deny check

# Advisories only
cargo deny check advisories
# Licenses only
cargo deny check licenses

Acknowledgements

Pop CLI would not be possible without these awesome crates!

• Local network deployment powered by zombienet-sdk
• cargo contract a setup and deployment tool for developing Wasm based Smart Contracts via ink!
• Build deterministic runtimes powered by srtool-cli

License

The entire code within this repository is licensed under the GPLv3.

Please contact us if you have questions about the licensing of our products.