Enum Command

Source

pub enum Command {
Show 32 variants    Init {
        name: String,
        javascript: bool,
        no_install: bool,
        package_manager: Option<PackageManager>,
        no_git: bool,
        template: ProgramTemplate,
        test_template: TestTemplate,
        force: bool,
        install_agent_skills: bool,
    },
    Build {Show 13 fields
        skip_lint: bool,
        ignore_keys: bool,
        no_idl: bool,
        idl: Option<String>,
        idl_ts: Option<String>,
        verifiable: bool,
        program_name: Option<String>,
        solana_version: Option<String>,
        docker_image: Option<String>,
        bootstrap: BootstrapMode,
        env: Vec<String>,
        cargo_args: Vec<String>,
        no_docs: bool,
    },
    Expand {
        program_name: Option<String>,
        stdout: bool,
        cargo_args: Vec<String>,
    },
    Verify {
        program_id: Pubkey,
        repo_url: Option<String>,
        commit_hash: Option<String>,
        current_dir: bool,
        program_name: Option<String>,
        args: Vec<String>,
    },
    Test {Show 13 fields
        program_name: Option<String>,
        skip_deploy: bool,
        skip_lint: bool,
        skip_local_validator: bool,
        skip_build: bool,
        no_idl: bool,
        detach: bool,
        run: Vec<String>,
        validator: ValidatorType,
        profile: bool,
        args: Vec<String>,
        env: Vec<String>,
        cargo_args: Vec<String>,
    },
    New {
        name: String,
        template: ProgramTemplate,
        force: bool,
    },
    Debugger {
        test_name: Option<String>,
        skip_run: bool,
        skip_build: bool,
        skip_lint: bool,
        gdb: bool,
        cargo_args: Vec<String>,
    },
    Coverage {
        skip_run: bool,
        skip_build: bool,
        output: String,
        trace_dir: String,
        cargo_args: Vec<String>,
    },
    CoverageFilterHost {
        sbf_lcov: String,
        host_lcov: String,
        output: String,
    },
    Idl {
        subcmd: IdlCommand,
    },
    Clean,
    Deploy {
        program_name: Option<String>,
        program_keypair: Option<PathBuf>,
        verifiable: bool,
        no_idl: bool,
        solana_args: Vec<String>,
    },
    Migrate,
    Upgrade {
        program_id: Pubkey,
        program_filepath: PathBuf,
        max_retries: u32,
        solana_args: Vec<String>,
    },
    Airdrop {
        amount: f64,
        pubkey: Option<Pubkey>,
    },
    Cluster {
        subcmd: ClusterCommand,
    },
    Config {
        subcmd: ConfigCommand,
    },
    Shell,
    Run {
        script: String,
        script_args: Vec<String>,
    },
    Keys {
        subcmd: KeysCommand,
    },
    Localnet {
        skip_build: bool,
        skip_deploy: bool,
        skip_lint: bool,
        ignore_keys: bool,
        validator: ValidatorType,
        env: Vec<String>,
        cargo_args: Vec<String>,
    },
    Account {
        account_type: String,
        address: Pubkey,
        idl: Option<PathBuf>,
    },
    Completions {
        shell: Shell,
    },
    Address,
    Balance {
        pubkey: Option<Pubkey>,
        lamports: bool,
    },
    Epoch,
    EpochInfo,
    Logs {
        include_votes: bool,
        address: Option<Vec<Pubkey>>,
    },
    ShowAccount {
        cmd: ShowAccountCommand,
    },
    Keygen {
        subcmd: KeygenCommand,
    },
    Program {
        subcmd: ProgramCommand,
    },
    Codama {
        subcmd: CodamaCommand,
    },
}

Variants§

§

Init

Initializes a workspace.

Fields

§name: String

Workspace name

§javascript: bool

Use JavaScript instead of TypeScript

§no_install: bool

Don’t install JavaScript dependencies

§package_manager: Option<PackageManager>

Package Manager to use. If omitted, detection cascades pnpm → yarn → npm and picks the first one on PATH. When set explicitly, the chosen binary must be installed — no silent fallback.

§no_git: bool

Don’t initialize git

§template: ProgramTemplate

Rust program template to use

§test_template: TestTemplate

Test template to use

§force: bool

Initialize even if there are files

§install_agent_skills: bool

Install Solana agent skills

§

Build

Builds the workspace.

Fields

§skip_lint: bool

True if the build should not fail even if there are no “CHECK” comments

§ignore_keys: bool

Skip checking for program ID mismatch between keypair and declare_id

§no_idl: bool

Do not build the IDL

§idl: Option<String>

Output directory for the IDL.

§idl_ts: Option<String>

Output directory for the TypeScript IDL.

§verifiable: bool

True if the build artifact needs to be deterministic and verifiable.

§program_name: Option<String>

Name of the program to build

§solana_version: Option<String>

Version of the Solana toolchain to use. For –verifiable builds only.

§docker_image: Option<String>

Docker image to use. For –verifiable builds only.

§bootstrap: BootstrapMode

Bootstrap docker image from scratch, installing all requirements for verifiable builds. Only works for debian-based images.

§env: Vec<String>

Environment variables to pass into the docker container

§cargo_args: Vec<String>

Arguments to pass to the underlying cargo build-sbf command

§no_docs: bool

Suppress doc strings in IDL output

§

Expand

Expands macros (wrapper around cargo expand)

Use it in a program folder to expand program

Use it in a workspace but outside a program folder to expand the entire workspace

Fields

§program_name: Option<String>

Expand only this program

§stdout: bool

Write to stdout

§cargo_args: Vec<String>

Arguments to pass to the underlying cargo expand command

§

Verify

Verifies the on-chain bytecode matches the locally compiled artifact. Run this command inside a program subdirectory, i.e., in the dir containing the program’s Cargo.toml.

Fields

§program_id: Pubkey

The program ID to verify.

§repo_url: Option<String>

The URL of the repository to verify against. Conflicts with --current-dir.

§commit_hash: Option<String>

The commit hash to verify against. Requires --repo-url.

§current_dir: bool

Verify against the source code in the current directory. Conflicts with --repo-url.

§program_name: Option<String>

Name of the program to run the command on. Defaults to the package name.

§args: Vec<String>

Any additional arguments to pass to solana-verify.

§

Test

Runs integration tests.

Fields

§program_name: Option<String>

Build and test only this program

§skip_deploy: bool

Use this flag if you want to run tests against previously deployed programs.

§skip_lint: bool

True if the build should not fail even if there are no “CHECK” comments where normally required

§skip_local_validator: bool

Flag to skip starting a local validator, if the configured cluster url is a localnet.

§skip_build: bool

Flag to skip building the program in the workspace, use this to save time when running test and the program code is not altered.

§no_idl: bool

Do not build the IDL

§detach: bool

Flag to keep the local validator running after tests to be able to check the transactions.

§run: Vec<String>

Run the test suites under the specified path

§validator: ValidatorType

Validator type to use for local testing

§profile: bool

Profile each test: record per-test SBF register traces and render a flamegraph SVG per test under target/anchor-v2-profile/. Forces a debug build (DWARF is required for symbolication) and activates the profile cargo feature. Rust tests only.

§args: Vec<String>

§env: Vec<String>

Environment variables to pass into the docker container

§cargo_args: Vec<String>

Arguments to pass to the underlying cargo build-sbf command.

§

New

Creates a new program.

Fields

§name: String

Program name

§template: ProgramTemplate

Rust program template to use

§force: bool

Create new program even if there is already one

§

Debugger

Run tests under a foundry-style instruction-level debugger.

Reuses the anchor test --profile trace pipeline: rebuilds with DWARF, runs the test suite via anchor-v2-testing (LiteSVM in-process), then opens a ratatui TUI over the captured SBF register traces instead of rendering flamegraphs. Never touches a validator — LiteSVM is the only runtime that produces the traces this consumes.

Fields

§test_name: Option<String>

Filter captured traces to tests whose name contains this substring. If omitted, the TUI opens with a picker across every captured (test, tx) pair.

§skip_run: bool

Skip the build+test phase and open the TUI directly over whatever traces already exist under target/anchor-v2-profile/.

§skip_build: bool

Skip cargo build-sbf. Use when the .so is already up to date — saves a rebuild but fails if the deploy artifact is missing.

§skip_lint: bool

Forwarded to the underlying anchor test invocation.

§gdb: bool

Drive tests over sbpf’s gdb-stub instead of reading dumped trace files. Per-step register snapshots + exact CU are collected live via the gdb remote serial protocol. 100-1000× slower than the default register-tracing path, but needs no fork to emit CU values (sbpf exposes cu_remaining as register 12).

§cargo_args: Vec<String>

Arguments to pass to the underlying cargo build-sbf command.

§

Coverage

Generate source-level code coverage from SBF register traces.

Builds programs with DWARF debug info, runs the test suite with litesvm register tracing enabled, then maps executed PCs to source lines via addr2line and outputs LCOV.

Fields

§skip_run: bool

Skip the build+test phase and generate coverage from existing traces in SBF_TRACE_DIR.

§skip_build: bool

Skip cargo build-sbf. Use when the .so is already up to date.

§output: String

Output path for the LCOV file.

§trace_dir: String

Directory containing register trace files.

§cargo_args: Vec<String>

Arguments to pass to the underlying cargo test command.

§

CoverageFilterHost

Filter host LCOV before merging it with SBF coverage.

Fields

§sbf_lcov: String

LCOV generated from SBF register traces.

§host_lcov: String

LCOV generated by cargo-llvm-cov on the host.

§output: String

Output path for the filtered host LCOV.

§

Idl

Commands for interacting with interface definitions.

Fields

§subcmd: IdlCommand

§

Clean

Remove all artifacts from the generated directories except program keypairs.

§