Enum anchor_cli::Command

pub enum Command {
    Init {
        name: String,
        javascript: bool,
        no_git: bool,
        jest: bool,
    },
    Build {
        idl: Option<String>,
        skip_lint: bool,
        idl_ts: Option<String>,
        verifiable: bool,
        program_name: Option<String>,
        solana_version: Option<String>,
        docker_image: Option<String>,
        bootstrap: BootstrapMode,
        cargo_args: Vec<String>,
        no_docs: bool,
    },
    Expand {
        program_name: Option<String>,
        cargo_args: Vec<String>,
    },
    Verify {
        program_id: Pubkey,
        program_name: Option<String>,
        solana_version: Option<String>,
        docker_image: Option<String>,
        bootstrap: BootstrapMode,
        cargo_args: Vec<String>,
    },
    Test {
        skip_deploy: bool,
        skip_lint: bool,
        skip_local_validator: bool,
        skip_build: bool,
        detach: bool,
        run: Vec<String>,
        args: Vec<String>,
        cargo_args: Vec<String>,
    },
    New {
        name: String,
    },
    Idl {
        subcmd: IdlCommand,
    },
    Clean,
    Deploy {
        program_name: Option<String>,
        program_keypair: Option<String>,
    },
    Migrate,
    Upgrade {
        program_id: Pubkey,
        program_filepath: String,
    },
    Cluster {
        subcmd: ClusterCommand,
    },
    Shell,
    Run {
        script: String,
        script_args: Vec<String>,
    },
    Login {
        token: String,
    },
    Publish {
        program: String,
        cargo_args: Vec<String>,
        skip_build: bool,
    },
    Keys {
        subcmd: KeysCommand,
    },
    Localnet {
        skip_build: bool,
        skip_deploy: bool,
        skip_lint: bool,
        cargo_args: Vec<String>,
    },
    Account {
        account_type: String,
        address: Pubkey,
        idl: Option<String>,
    },
}

Variants

Init

Fields

name: String

javascript: bool

no_git: bool

jest: bool

Initializes a workspace.

Build

Fields

idl: Option<String>

Output directory for the IDL.

skip_lint: bool

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

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>

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.

cargo_args: Vec<String>

Arguments to pass to the underlying cargo build-bpf command

no_docs: bool

Suppress doc strings in IDL output

Builds the workspace.

Expand

Fields

program_name: Option<String>

Expand only this program

cargo_args: Vec<String>

Arguments to pass to the underlying cargo expand command

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

Verify

Fields

program_id: Pubkey

The deployed program to compare against.

program_name: Option<String>

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.

cargo_args: Vec<String>

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

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.

Test

Fields

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.

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

args: Vec<String>

cargo_args: Vec<String>

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

Runs integration tests against a localnetwork.

New

Fields

name: String

Creates a new program.

Idl

Fields

subcmd: IdlCommand

Commands for interacting with interface definitions.

Clean

Remove all artifacts from the target directory except program keypairs.

Deploy

Fields

program_name: Option<String>

Only deploy this program

program_keypair: Option<String>

Keypair of the program (filepath) (requires program-name)

Deploys each program in the workspace.

Migrate

Runs the deploy migration script.

Upgrade

Fields

program_id: Pubkey

The program to upgrade.

program_filepath: String

Filepath to the new program binary.

Deploys, initializes an IDL, and migrates all in one command. Upgrades a single program. The configured wallet must be the upgrade authority.

Cluster

Fields

subcmd: ClusterCommand

Cluster commands.

Shell

Starts a node shell with an Anchor client setup according to the local config.

Run

Fields

script: String

The name of the script to run.

script_args: Vec<String>

Argument to pass to the underlying script.

Runs the script defined by the current workspace’s Anchor.toml.

Login

Fields

token: String

API access token.

Saves an api token from the registry locally.

Publish

Fields

program: String

The name of the program to publish.

cargo_args: Vec<String>

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

skip_build: bool

Flag to skip building the program in the workspace, use this to save time when publishing the program

Publishes a verified build to the Anchor registry.

Keys

Fields

subcmd: KeysCommand

Keypair commands.

Localnet

Fields

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.

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

cargo_args: Vec<String>

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

Localnet commands.

Account

Fields

account_type: String

Account struct to deserialize

address: Pubkey

Address of the account to deserialize

idl: Option<String>

IDL to use (defaults to workspace IDL)

Fetch and deserialize an account using the IDL provided.

Trait Implementations

impl CommandFactory for Command

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Command

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for Command

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut(
    __clap_arg_matches: &mut ArgMatches
) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches(
    &mut self,
    __clap_arg_matches: &ArgMatches
) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>(
    &mut self,
    __clap_arg_matches: &mut ArgMatches
) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Command

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error<RichFormatter>>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Selfwhere
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error<RichFormatter>>where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Update from iterator, exit on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error<RichFormatter>>where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Subcommand for Command

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self.

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can update self.

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand