Enum sugar_cli::cli::Commands

pub enum Commands {
    Bundlr {
        keypair: Option<String>,
        rpc_url: Option<String>,
        action: BundlrAction,
    },
    Collection {
        command: CollectionSubcommands,
    },
    Config {
        command: ConfigSubcommands,
    },
    Deploy {
        config: String,
        keypair: Option<String>,
        rpc_url: Option<String>,
        cache: String,
        collection_mint: Option<String>,
    },
    Freeze {
        command: FreezeCommand,
    },
    Guard {
        command: GuardCommand,
    },
    Hash {
        config: String,
        cache: String,
        compare: Option<String>,
    },
    Launch {
        assets_dir: String,
        keypair: Option<String>,
        config: String,
        rpc_url: Option<String>,
        cache: String,
        strict: bool,
        skip_collection_prompt: bool,
    },
    Mint {
        keypair: Option<String>,
        rpc_url: Option<String>,
        cache: String,
        number: Option<u64>,
        receiver: Option<String>,
        candy_machine: Option<String>,
    },
    Airdrop {
        keypair: Option<String>,
        rpc_url: Option<String>,
        cache: String,
        candy_machine: Option<String>,
        airdrop_list: String,
    },
    Reveal {
        keypair: Option<String>,
        rpc_url: Option<String>,
        cache: String,
        config: String,
        timeout: Option<u64>,
    },
    Show {
        keypair: Option<String>,
        rpc_url: Option<String>,
        cache: String,
        candy_machine: Option<String>,
        unminted: bool,
    },
    Sign {
        keypair: Option<String>,
        rpc_url: Option<String>,
        cache: String,
        mint: Option<String>,
        candy_machine_id: Option<String>,
    },
    Upload {
        assets_dir: String,
        config: String,
        keypair: Option<String>,
        rpc_url: Option<String>,
        cache: String,
    },
    Validate {
        assets_dir: String,
        strict: bool,
        skip_collection_prompt: bool,
    },
    Verify {
        keypair: Option<String>,
        rpc_url: Option<String>,
        cache: String,
    },
    Withdraw {
        candy_machine: Option<String>,
        keypair: Option<String>,
        rpc_url: Option<String>,
        list: bool,
    },
}

Variants

Bundlr

Fields

keypair: Option<String>

Path to the keypair file, uses Sol config or defaults to “~/.config/solana/id.json”

rpc_url: Option<String>

RPC Url

action: BundlrAction

Interact with the bundlr network

Collection

Fields

command: CollectionSubcommands

Manage the collection on the candy machine

Config

Fields

command: ConfigSubcommands

Manage candy machine configuration

Deploy

Fields

config: String

Path to the config file, defaults to “config.json”

keypair: Option<String>

Path to the keypair file, uses Sol config or defaults to “~/.config/solana/id.json”

rpc_url: Option<String>

RPC Url

cache: String

Path to the cache file, defaults to “cache.json”

collection_mint: Option<String>

The optional collection address where the candymachine will mint the tokens to

Deploy cache items into candy machine config on-chain

Freeze

Fields

command: FreezeCommand

Manage freeze guard actions

Guard

Fields

command: GuardCommand

Manage guards on the candy machine

Hash

Fields

config: String

Path to the config file, defaults to “config.json”

cache: String

Path to the cache file, defaults to “cache.json”

compare: Option<String>

Compare a provided hash with a cache file to check integrity.

Generate hash of cache file for hidden settings.

Launch

Fields

assets_dir: String

Path to the directory with the assets to upload

keypair: Option<String>

Path to the keypair file [default: solana config or “~/.config/solana/id.json”]

config: String

Path to the config file

rpc_url: Option<String>

RPC Url

cache: String

Path to the cache file

strict: bool

Strict mode: validate against JSON metadata standard exactly

skip_collection_prompt: bool

Skip collection validate prompt

Create a candy machine deployment from assets

Mint

Fields

keypair: Option<String>

Path to the keypair file, uses Sol config or defaults to “~/.config/solana/id.json”

rpc_url: Option<String>

RPC Url

cache: String

Path to the cache file, defaults to “cache.json”

number: Option<u64>

Amount of NFTs to be minted in bulk

receiver: Option<String>

Public key of the receiver of the minted NFT, defaults to keypair

candy_machine: Option<String>

Address of candy machine to mint from.

Mint one NFT from candy machine

Airdrop

Fields

keypair: Option<String>

Path to the keypair file, uses Sol config or defaults to “~/.config/solana/id.json”

rpc_url: Option<String>

RPC Url

cache: String

Path to the cache file, defaults to “cache.json”

candy_machine: Option<String>

Address of candy machine to mint from.

airdrop_list: String

List of airdrop targets.

Airdrop NFTs from candy machine

Reveal

Fields

keypair: Option<String>

Path to the keypair file, uses Sol config or defaults to “~/.config/solana/id.json”

rpc_url: Option<String>

RPC Url

cache: String

Path to the cache file, defaults to “cache.json”

config: String

Path to the config file

timeout: Option<u64>

RPC timeout to retrieve the mint list (in seconds).

Reveal the NFTs from a hidden settings candy machine

Show

Fields

keypair: Option<String>

Path to the keypair file, uses Sol config or defaults to “~/.config/solana/id.json”

rpc_url: Option<String>

RPC Url

cache: String

Path to the cache file, defaults to “cache.json”

candy_machine: Option<String>

Address of candy machine

unminted: bool

Display a list of unminted indices

Show the on-chain config of an existing candy machine

Sign

Fields

keypair: Option<String>

Path to the keypair file, uses Sol config or defaults to “~/.config/solana/id.json”

rpc_url: Option<String>

RPC Url

cache: String

Path to the cache file, defaults to “cache.json”

mint: Option<String>

Mint id for single NFT to be signed

candy_machine_id: Option<String>

Candy machine id.

Sign one or all NFTs from candy machine

Upload

Fields

assets_dir: String

Path to the directory with the assets to upload

config: String

Path to the config file

keypair: Option<String>

Path to the keypair file [default: solana config or “~/.config/solana/id.json”]

rpc_url: Option<String>

RPC Url

cache: String

Path to the cache file

Upload assets to storage and creates the cache config

Validate

Fields

assets_dir: String

Assets directory to upload, defaults to “assets”

strict: bool

Strict mode: validate against JSON metadata standard exactly

skip_collection_prompt: bool

Skip collection prompt

Validate JSON metadata files

Verify

Fields

keypair: Option<String>

Path to the keypair file, uses Sol config or defaults to “~/.config/solana/id.json”

rpc_url: Option<String>

RPC Url

cache: String

Path to the cache file, defaults to “cache.json”

Verify uploaded data

Withdraw

Fields

candy_machine: Option<String>

Address of candy machine to withdraw funds from.

keypair: Option<String>

Path to the keypair file, uses Sol config or defaults to “~/.config/solana/id.json”

rpc_url: Option<String>

RPC Url

list: bool

List available candy machines, no withdraw performed

Withdraw funds a from candy machine account closing it

Trait Implementations

impl FromArgMatches for Commands

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 Subcommand for Commands

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

Append to Command so it can instantiate Self.

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

Append to Command so it can update self.

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand