Skip to main content

Working with Sugar

Sugar Tutorial

Full Sugar Video Tutorial

Sugar contains a collection of commands for creating and managing Metaplex Candy Machines. The complete list of commands can be viewed by running:

sugar

This will display a list of commands and their short description:

USAGE:
sugar [OPTIONS] <SUBCOMMAND>

OPTIONS:
-h, --help Print help information
-l, --log-level <LOG_LEVEL> Log level: trace, debug, info, warn, error, off
-V, --version Print version information

SUBCOMMANDS:
create-config Interactive process to create the config file
deploy Deploy cache items into candy machine config on-chain
help Print this message or the help of the given subcommand(s)
launch Create a candy machine deployment from assets
mint Mint one NFT from candy machine
show Show the on-chain config of an existing candy machine
update Update the candy machine config on-chain
upload Upload assets to storage and creates the cache config
validate Validate JSON metadata files
verify Verify uploaded data
withdraw Withdraw funds from candy machine account closing it

To get more information about a particular command (e.g., deploy), use the help command:

sugar help deploy

The list of options together with a short description will be displayed:

Deploy cache items into candy machine config on-chain

USAGE:
sugar deploy [OPTIONS]

OPTIONS:
-c, --config <CONFIG> Path to the config file, defaults to "config.json" [default:
config.json]
--cache <CACHE> Path to the cache file, defaults to "cache.json" [default:
cache.json]
-h, --help Print help information
-k, --keypair <KEYPAIR> Path to the keypair file, uses Sol config or defaults to
"~/.config/solana/id.json"
-l, --log-level <LOG_LEVEL> Log level: trace, debug, info, warn, error, off
-r, --rpc-url <RPC_URL> RPC Url

Note: This guide assumes that you set up your RPC url and a keypair using Solana CLI config, as described in the Quick Start section above.