The primary addValidator command adds an Avalanche node as a validator in the Avalanche Primary Network with AddPermissionlessValidatorTx.
This command requires the node's BLS key and proof of possession key, more information regarding BLS can be found here.
To get a node's BLS key and proof of possession key, call info.getNodeID API as shown here
Usage:
avalanche primary addValidator [flags]
Flags:
--nodeID string the node ID of the validator-k, --key string select the key to use [fuji deploy only] --weight uint set the staking weight of the validator --start-time string UTC start time when this validator starts validating, in 'YYYY-MM-DD HH:MM:SS' format --staking-period duration how long this validator will be staking --fuji fuji join on fuji (alias for `testnet`) --testnet testnet join on testnet (alias for `fuji`) --mainnet mainnet join on mainnet-g, --ledger use ledger instead of key (always true on mainnet, defaults to false on fuji) --ledger-addrs strings use the given ledger addresses --public-key string set the BLS public key of the validator --proof-of-possession string set the BLS proof of possession of the validator --delegation-fee uint set the delegation fee (20 000 is equivalent to 2%)
The subnet command suite provides a collection of tools for developing and deploying Subnets.
To get started, use the blockchain create command wizard to walk through the configuration of your very first Subnet. Then, go ahead and deploy it with the blockchain deploy command. You can use the rest of the commands to manage your Subnet configurations and live deployments.
The blockchain addValidator command whitelists a primary network validator to validate the provided deployed Subnet.
To add the validator to the Subnet's allow list, you first need to provide the subnetName and the validator's unique NodeID. The command then prompts for the validation start time, duration, and stake weight. You can bypass these prompts by providing the values with flags.
This command currently only works on Subnets deployed to either the Fuji Testnet or Mainnet.
--default-validator-params use default weight/start/duration params for subnet validator --devnet devnet add subnet validator on devnet --endpoint string use the given endpoint for network operations-e, --ewoq use ewoq key [fuji/devnet only] --fuji fuji add subnet validator on fuji (alias for `testnet`)-h, --help help for addValidator-k, --key string select the key to use [fuji/devnet only]-g, --ledger use ledger instead of key (always true on mainnet, defaults to false on fuji/devnet) --ledger-addrs strings use the given ledger addresses --local local add subnet validator on local --mainnet mainnet add subnet validator on mainnet --nodeID string set the NodeID of the validator to add --output-tx-path string file path of the add validator tx --staking-period duration how long this validator will be staking --start-time string UTC start time when this validator starts validating, in 'YYYY-MM-DD HH:MM:SS' format --subnet-auth-keys strings control keys that will be used to authenticate add validator tx --testnet testnet add subnet validator on testnet (alias for `fuji`) --weight uint set the staking weight of the validator to add
--fuji remove validator in existing fuji deployment (alias for `testnet`)-k, --key string select the key to use [fuji only]-g, --ledger use ledger instead of key (always true on mainnet, defaults to false on fuji) --ledger-addrs strings use the given ledger addresses --local remove validator in existing local deployment --mainnet remove validator in existing mainnet deployment --nodeID string node id of node to be added as validator in elastic subnet --output-tx-path string file path of the removeValidator tx --subnet-auth-keys strings control keys that will be used to authenticate removeValidator tx --testnet remove validator in existing testnet deployment (alias for `fuji`)
--control-keys strings addresses that may make subnet changes --devnet devnet change subnet owner on devnet --endpoint string use the given endpoint for network operations-e, --ewoq use ewoq key [fuji/devnet] --fuji fuji change subnet owner on fuji (alias for `testnet`)-h, --help help for changeOwner-k, --key string select the key to use [fuji/devnet]-g, --ledger use ledger instead of key (always true on mainnet, defaults to false on fuji/devnet) --ledger-addrs strings use the given ledger addresses --local local change subnet owner on local --mainnet mainnet change subnet owner on mainnet --output-tx-path string file path of the transfer subnet ownership tx-s, --same-control-key use the fee-paying key as control key --subnet-auth-keys strings control keys that will be used to authenticate transfer subnet ownership tx --testnet testnet change subnet owner on testnet (alias for `fuji`) --threshold uint32 required number of control key signatures to make subnet changes
AvalancheGo nodes support several different configuration files. Subnets have their own Subnet config which applies to all chains/VMs in the Subnet. Each chain within the Subnet can have its own chain config. This command allows you to set both config files.
--chain-config string path to the chain configuration-h, --help help for configure --per-node-chain-config string path to per node chain configuration for local network --subnet-config string path to the subnet configuration
The blockchain create command builds a new genesis file to configure your Subnet. By default, the command runs an interactive wizard. It walks you through all the steps you need to create your first Subnet.
The tool supports deploying Subnet-EVM and custom VMs. You can create a custom, user-generated genesis with a custom VM by providing the path to your genesis and VM binaries with the --genesis and --vm flags.
By default, running the command with a subnetName that already exists causes the command to fail. If you'd like to overwrite an existing configuration, pass the -f flag.
Usage:
avalanche blockchain create [subnetName] [flags]
Flags:
--custom use a custom VM template --custom-vm-branch string custom vm branch --custom-vm-build-script string custom vm build-script --custom-vm-path string file path of custom vm to use --custom-vm-repo-url string custom vm repository url --evm use the Subnet-EVM as the base template --evm-chain-id uint chain ID to use with Subnet-EVM --evm-defaults use default settings for fees/airdrop/precompiles with Subnet-EVM --evm-token string token name to use with Subnet-EVM-f, --force overwrite the existing configuration if one exists --from-github-repo generate custom VM binary from github repository --genesis string file path of genesis to use-h, --help help for create --latest use latest Subnet-EVM released version, takes precedence over --vm-version --pre-release use latest Subnet-EVM pre-released version, takes precedence over --vm-version --relayer run AWM relayer when deploying the vm --teleporter generate a teleporter-ready vm (default true) --vm string file path of custom vm to use. alias to custom-vm-path --vm-version string version of Subnet-EVM template to use --warp generate a vm with warp support (needed for teleporter)
The blockchain deploy command deploys your Subnet configuration locally, to Fuji Testnet, or to Mainnet.
At the end of the call, the command prints the RPC URL you can use to interact with the Subnet.
Avalanche-CLI only supports deploying an individual Subnet once per network. Subsequent attempts to deploy the same Subnet to the same network (local, Fuji, Mainnet) aren't allowed. If you'd like to redeploy a Subnet locally for testing, you must first call avalanche network clean to reset all deployed chain state. Subsequent local deploys redeploy the chain with fresh state. You can deploy the same Subnet to multiple networks, so you can take your locally tested Subnet and deploy it on Fuji or Mainnet.
Usage:
avalanche blockchain deploy [subnetName] [flags]
Flags:
--avalanchego-path string use this avalanchego binary path --avalanchego-version string use this version of avalanchego (ex: v1.17.12) (default "latest") --control-keys strings addresses that may make subnet changes --devnet deploy to a devnet network --endpoint string use the given endpoint for network operations-e, --ewoq use ewoq key [fuji/devnet deploy only]-f, --fuji testnet deploy to fuji (alias to testnet-h, --help help for deploy-k, --key string select the key to use [fuji/devnet deploy only]-g, --ledger use ledger instead of key (always true on mainnet, defaults to false on fuji/devnet) --ledger-addrs strings use the given ledger addresses-l, --local deploy to a local network-m, --mainnet deploy to mainnet --mainnet-chain-id string use different ChainID for mainnet deployment --output-tx-path string file path of the blockchain creation tx-s, --same-control-key use creation key as control key --subnet-auth-keys strings control keys that will be used to authenticate chain creation-u, --subnet-id string deploy into given subnet id-t, --testnet fuji deploy to testnet (alias to fuji) --threshold uint32 required number of control key signatures to make subnet changes
The blockchain describe command prints the details of a Subnet configuration to the console. By default, the command prints a summary of the configuration. By providing the --genesis flag, the command instead prints out the raw genesis file.
The blockchain import command imports configurations into Avalanche-CLI.
This command supports importing from a file created on another computer, or importing from Subnets running public networks (for example, created manually or with the deprecated Subnet-CLI)
To import from a file, you can optionally provide the path as a command-line argument. Alternatively, running the command without any arguments triggers an interactive wizard. To import from a repository, go through the wizard. By default, an imported Subnet doesn't overwrite an existing Subnet with the same name. To allow overwrites, provide the --force flag.
--branch string the repo branch to use if downloading a new repo-f, --force overwrite the existing configuration if one exists-h, --help help for import --repo string the repo to import (ex: ava-labs/avalanche-plugins-core) or url to download the repo from --subnet string the subnet configuration to import from the provided repo
The blockchain import public command imports a Subnet configuration from a running network.
The genesis file should be available from the disk for this to work. By default, an imported Subnet doesn't overwrite an existing Subnet with the same name. To allow overwrites, provide the --force flag.
Usage:
avalanche blockchain import public [subnetPath] [flags]
Flags:
--custom use a custom VM template --evm import a subnet-evm-f, --force overwrite the existing configuration if one exists --fuji fuji import from fuji (alias for `testnet`) --genesis-file-path string path to the genesis file-h, --help help for public --mainnet mainnet import from mainnet --node-url string [optional] URL of an already running subnet validator --subnet-id string the subnet ID --testnet testnet import from testnet (alias for `fuji`)
The blockchain join command configures your validator node to begin validating a new Subnet.
To complete this process, you must have access to the machine running your validator. If the CLI is running on the same machine as your validator, it can generate or update your node's config file automatically. Alternatively, the command can print the necessary instructions to update your node manually. To complete the validation process, the Subnet's admins must add the NodeID of your validator to the Subnet's allow list by calling addValidator with your NodeID.
After you update your validator's config, you need to restart your validator manually. If you provide the --avalanchego-config flag, this command attempts to edit the config file at that path.
This command currently only supports Subnets deployed on the Fuji Testnet and Mainnet.
Usage:
avalanche blockchain join [subnetName] [flags]
Flags:
--avalanchego-config string file path of the avalanchego config file --fail-if-not-validating fail if whitelist check fails --force-whitelist-check if true, force the whitelist check --force-write if true, skip to prompt to overwrite the config file --fuji fuji join on fuji (alias for `testnet`)-h, --help help for join --mainnet mainnet join on mainnet --nodeID string set the NodeID of the validator to check --plugin-dir string file path of avalanchego's plugin directory --print if true, print the manual config without prompting --skip-whitelist-check if true, skip the whitelist check --testnet testnet join on testnet (alias for `fuji`)
The blockchain list command prints the names of all created Subnet configurations. Without any flags, it prints some general, static information about the Subnet. With the --deployed flag, the command shows additional information including the VMID, BlockchainID and SubnetID.
Usage:
avalanche blockchain list [flags]
Flags:
--deployed show additional deploy information-h, --help help for list
The blockchain publish command publishes the Subnet's VM to a repository.
Usage:
avalanche blockchain publish [subnetName] [flags]
Flags:
--alias string We publish to a remote repo, but identify the repo locally under a user-provided alias (e.g. myrepo). --force If true, ignores if the subnet has been published in the past, and attempts a forced publish.-h, --help help for publish --no-repo-path string Do not let the tool manage file publishing, but have it only generate the files and put them in the location given by this flag. --repo-url string The URL of the repo where we are publishing --subnet-file-path string Path to the Subnet description file. If not given, a prompting sequence will be initiated. --vm-file-path string Path to the VM description file. If not given, a prompting sequence will be initiated.
The blockchain stats command prints validator statistics for the given Subnet.
Usage:
avalanche blockchain stats [subnetName] [flags]
Flags:
--fuji fuji print stats on fuji (alias for `testnet`)-h, --help help for stats --mainnet mainnet print stats on mainnet --testnet testnet print stats on testnet (alias for `fuji`)
This command transforms your permissioned Subnet into an Elastic Subnet (NOTE: this action is irreversible).
Usage:
avalanche blockchain elastic [subnetName] [flags]
Flags:
--default If true, use default elastic subnet config values --denonimation int specify the token denomination (for Fuji and Mainnet only) --force If true, override transform into elastic subnet warning --fuji elastic subnet transform existing fuji deployment (alias for `testnet`)-k, --key string select the key to use [fuji only]-g, --ledger use ledger instead of key (always true on mainnet, defaults to false on fuji) --ledger-addrs strings use the given ledger addresses --local elastic subnet transform existing local deployment --mainnet elastic subnet transform existing mainnet deployment --output-tx-path string file path of the transformSubnet tx --stake-amount int amount of tokens to stake on validator --staking-period string how long validator validates for after start time --start-time string when validator starts validating (format as "2006-01-02 15:00:00") --subnet-auth-keys strings control keys that will be used to authenticate transformSubnet tx --testnet elastic subnet transform existing testnet deployment (alias for `fuji`) --tokenName string specify the token name --tokenSymbol string specify the token symbol --transform-validators If true, transform validators to permissionless validators after elastic transform
--fuji add permissionless validator in existing fuji deployment (alias for `testnet`)-k, --key string select the key to use [fuji only]-g, --ledger use ledger instead of key (always true on mainnet, defaults to false on fuji) --ledger-addrs strings use the given ledger addresses --local add permissionless validator in existing local deployment --mainnet add permissionless validator in existing mainnet deployment --nodeID string node id of node to be added as validator in elastic subnet --stake-amount int amount of tokens to stake on validator --staking-period string how long validator validates for after start time --start-time string when validator starts validating (format as "2006-01-02 15:00:00") --testnet add permissionless validator in existing testnet deployment (alias for `fuji`)
--fuji add permissionless delegator in existing fuji deployment (alias for `testnet`)-k, --key string select the key to use [fuji only]-g, --ledger use ledger instead of key (always true on mainnet, defaults to false on fuji) --ledger-addrs strings use the given ledger addresses --local add permissionless delegator in existing local deployment --mainnet add permissionless delegator in existing mainnet deployment --nodeID string node id of node to be added as validator in elastic subnet --stake-amount int amount of tokens to delegate to validator --staking-period string how long to delegate for after start time --start-time string when to starts delegating (format as "2006-01-02 15:00:00") --testnet add permissionless delegator in existing testnet deployment (alias for `fuji`)
Apply generated upgrade bytes to running Subnet nodes to trigger a network upgrade.
For public networks (Fuji Testnet or Mainnet), to complete this process, you must have access to the machine running your validator. If the CLI is running on the same machine as your validator, it can manipulate your node's configuration automatically. Alternatively, the command can print the necessary instructions to upgrade your node manually.
After you update your validator's configuration, you need to restart your validator manually. If you provide the --avalanchego-chain-config-dir flag, this command attempts to write the upgrade file at that path. Refer to this doc for related documentation.
--avalanchego-chain-config-dir string avalanchego's chain config file directory (default "/Users/connor/.avalanchego/chains") --config create upgrade config for future subnet deployments (same as generate) --force If true, don't prompt for confirmation of timestamps in the past --fuji fuji apply upgrade existing fuji deployment (alias for `testnet`)-h, --help help for apply --local local apply upgrade existing local deployment --mainnet mainnet apply upgrade existing mainnet deployment --print if true, print the manual config without prompting (for public networks only) --testnet testnet apply upgrade existing testnet deployment (alias for `fuji`)
--force If true, overwrite a possibly existing file without prompting-h, --help help for export --upgrade-filepath string Export upgrade bytes file to location of choice on disk
The blockchain upgrade generate command builds a new upgrade.json file to customize your Subnet. It guides the user through the process using an interactive wizard.
The blockchain upgrade vm command enables the user to upgrade their Subnet's VM binary. The command can upgrade both local Subnets and publicly deployed Subnets on Fuji and Mainnet.
The command walks the user through an interactive wizard. The user can skip the wizard by providing command line flags.
The node command suite provides a collection of tools for creating and maintaining validators on the Avalanche Network.
To get started, use the node create command wizard to walk through the configuration to make your node a primary validator on Avalanche public network. You can use the rest of the commands to maintain your node and make your node a Subnet Validator.
(ALPHA Warning) This command is currently in experimental mode.
The node create command sets up a validator on a cloud server of your choice. The validator will be validating the Avalanche Primary Network and Subnet of your choice. By default, the command runs an interactive wizard. It walks you through all the steps you need to set up a validator. Validators can be deployed in multiple regions/zones simultaneously. Once this command is run, you will have to wait for the validator to finish bootstrapping on the primary network before running further commands on it, for example validating a Subnet. You can check the bootstrapping status by running avalanche node status.
The created node will be part of group of validators called <clusterName> and users can call node commands with <clusterName> so that the command will apply to all nodes in the cluster.
Usage:
avalanche node create [clusterName] [flags]
Flags:
--alternative-key-pair-name string key pair name to use if default one generates conflicts --authorize-access authorize CLI to create cloud resources --avalanchego-version-from-subnet string install latest avalanchego version, that is compatible with the given subnet, on node/s --aws create node/s in AWS cloud --aws-profile string aws profile to use (default "default") --custom-avalanchego-version string install given avalanchego version on node/s --devnet create node/s into a new Devnet --devnet-api-nodes int number of API nodes(nodes without stake) to create in the new Devnet --fuji create node/s in Fuji Network --gcp create node/s in GCP cloud --gcp-credentials string use given GCP credentials --gcp-project string use given GCP project-h, --help help for create --latest-avalanchego-pre-release-version install latest avalanchego pre-release version on node/s --latest-avalanchego-version install latest avalanchego release version on node/s --node-type string cloud instance type. Use 'default' to use recommended default instance type --num-nodes ints number of nodes to create per region(s). Use comma to separate multiple numbers for each region in the same order as --region flag --region strings create node(s) in given region(s). Use comma to separate multiple regions --same-monitoring-instance host monitoring for a cloud servers on the same instance --separate-monitoring-instance host monitoring for all cloud servers on a separate instance --skip-monitoring don't set up monitoring in created nodes --ssh-agent-identity string use given ssh identity(only for ssh agent). If not set, default will be used --use-ssh-agent use ssh agent(ex: Yubikey) for ssh auth --use-static-ip attach static Public IP on cloud servers (default true)
(ALPHA Warning) This command is currently in experimental mode.
The node devnet command suite provides a collection of commands related to devnets. You can check the updated status by calling avalanche node status <clusterName>
The node devnet deploy command deploys a Subnet into a devnet cluster, creating Subnet and blockchain TXs for it. It saves the deploy info both locally and remotely.
--alternative-key-pair-name string key pair name to use if default one generates conflicts --authorize-access authorize CLI to create cloud resources --avalanchego-version string install given avalanchego version on node/s --aws create node/s in AWS cloud --aws-profile string aws profile to use (default "default") --chain-config string path to the chain configuration for subnet --custom-subnet use a custom VM as the subnet virtual machine --custom-vm-branch string custom vm branch --custom-vm-build-script string custom vm build-script --custom-vm-repo-url string custom vm repository url --default-validator-params use default weight/start/duration params for subnet validator --devnet-api-nodes int number of API nodes(nodes without stake) to create in the new Devnet --evm-chain-id uint chain ID to use with Subnet-EVM --evm-defaults use default settings for fees/airdrop/precompiles with Subnet-EVM --evm-subnet use Subnet-EVM as the subnet virtual machine --evm-token string token name to use with Subnet-EVM --evm-version string version of Subnet-EVM to use --force-subnet-create overwrite the existing subnet configuration if one exists --gcp create node/s in GCP cloud --gcp-credentials string use given GCP credentials --gcp-project string use given GCP project-h, --help help for wiz --latest-avalanchego-pre-release-version install latest avalanchego pre-release version on node/s --latest-avalanchego-version install latest avalanchego release version on node/s --latest-evm-version use latest Subnet-EVM released version --latest-pre-released-evm-version use latest Subnet-EVM pre-released version --node-config string path to avalanchego node configuration for subnet --node-type string cloud instance type. Use 'default' to use recommended default instance type --num-nodes ints number of nodes to create per region(s). Use comma to separate multiple numbers for each region in the same order as --region flag --region strings create node/s in given region(s). Use comma to separate multiple regions --same-monitoring-instance host monitoring for a cloud servers on the same instance --separate-monitoring-instance host monitoring for all cloud servers on a separate instance --skip-monitoring don't set up monitoring in created nodes --ssh-agent-identity string use given ssh identity(only for ssh agent). If not set, default will be used. --subnet-config string path to the subnet configuration for subnet --subnet-genesis string file path of the subnet genesis --use-ssh-agent use ssh agent for ssh --use-static-ip attach static Public IP on cloud servers (default true) --validators strings deploy subnet into given comma separated list of validators. defaults to all cluster nodes
(ALPHA Warning) This command is currently in experimental mode.
The node ssh command execute a given command using ssh on all nodes in the cluster. If no command is given, just prints the ssh command line to be used to connect to each node.
(ALPHA Warning) This command is currently in experimental mode.
The node status command gets the bootstrap status of all nodes in a cluster with the Primary Network. If no cluster is given, defaults to node list behaviour.
To get the bootstrap status of a node with a Subnet, use the --subnet flag.
Usage:
avalanche node status [clusterName] [flags]
Flags:
-h, --help help for status --subnet string specify the subnet the node is syncing with
(ALPHA Warning) This command is currently in experimental mode.
The node stop command stops a running node in cloud server
Note that a stopped node may still incur cloud server storage fees.
Usage:
avalanche node stop [clusterName] [flags]
Flags:
--authorize-access authorize CLI to release cloud resources --authorize-remove authorize CLI to remove all local files related to cloud nodes-h, --help help for stop
(ALPHA Warning) This command is currently in experimental mode.
The node sync command enables all nodes in a cluster to be bootstrapped to a Subnet. You can check the Subnet bootstrap status by calling avalanche node status <clusterName> --subnet <blockchainName>
(ALPHA Warning) This command is currently in experimental mode.
The node update command suite provides a collection of commands for nodes to update their AvalancheGo version or VM version/config. You can check the status after update by running avalanche node status
(ALPHA Warning) This command is currently in experimental mode.
The node update subnet command updates all nodes in a cluster with latest Subnet configuration and You can check the updated Subnet bootstrap status by calling avalanche node status <clusterName> --subnet <blockchainName>
(ALPHA Warning) This command is currently in experimental mode.
The node validate command suite provides a collection of commands for nodes to join the Primary Network and Subnets as validators. If any of the commands is run before the nodes are bootstrapped on the Primary Network, the command will fail.
You can check the bootstrap status by running avalanche node status <clusterName>.
-f, --fuji testnet set up validator in fuji (alias to testnet-h, --help help for primary-k, --key string select the key to use [fuji only]-g, --ledger use ledger instead of key (always true on mainnet, defaults to false on fuji) --ledger-addrs strings use the given ledger addresses-m, --mainnet set up validator in mainnet --stake-amount uint how many AVAX to stake in the validator --staking-period duration how long validator validates for after start time-t, --testnet fuji set up validator in testnet (alias to fuji)
(ALPHA Warning) This command is currently in experimental mode.
The node validate subnet command enables all nodes in a cluster to be validators of a Subnet. If the command is run before the nodes are Primary Network validators, the command will first make the nodes Primary Network validators before making them Subnet validators. If The command is run before the nodes are bootstrapped on the Primary Network, the command will fail. You can check the bootstrap status by calling avalanche node status <clusterName>. If The command is run before the nodes are synced to the Subnet, the command will fail. You can check the Subnet sync status by calling avalanche node status <clusterName> --subnet <blockchainName>.
--default-validator-params use default weight/start/duration params for subnet validator-d, --devnet set up validator in devnet --endpoint string use the given endpoint for network operations-e, --ewoq use ewoq key [fuji/devnet only]-f, --fuji testnet set up validator in fuji (alias to testnet-h, --help help for subnet-k, --key string select the key to use [fuji/devnet only]-g, --ledger use ledger instead of key (always true on mainnet, defaults to false on fuji/devnet) --ledger-addrs strings use the given ledger addresses-m, --mainnet set up validator in mainnet --stake-amount uint how many AVAX to stake in the validator --staking-period duration how long validator validates for after start time --start-time string UTC start time when this validator starts validating, in 'YYYY-MM-DD HH:MM:SS' format-t, --testnet fuji set up validator in testnet (alias to fuji)
(ALPHA Warning) This command is currently in experimental mode.
The node whitelist command suite provides a collection of tools for granting access to the cluster.
Nodes created by Avalanche-CLI are protected by Cloud Security Group and only defined IP addresses are allowed to access. User IP is whitelisted automatically when cluster is created, but this command can be used in case of IP address changes or granting access to additional IPs. This command detects user current IP address automatically if no IP address is provided.
Secure SSH protocol is used to communicate with cloud instances. node whitelist command authorizes SSH public key on all nodes in the cluster if --ssh params is specified. Please keep your SSH private keys safe and secure, only share public keys to grant shell access to cloud instances running avalanchego.
(ALPHA Warning) This command is currently in experimental mode.
The node export command exports cluster configuration including their nodes to a text file. If no file is specified, the configuration is printed to the stdout. Use --include-secrets to include keys in the export. In this case this command can be used to backup your cluster configuration. Please keep the file secure as it contains sensitive information.
Exported cluster configuration without secrets it can be imported by another user using node import command.
Usage:
avalanche node export [clusterName] [flags]
Flags:
--file string specify the file to export the cluster configuration to --force overwrite the file if it exists -h, --help help for export --include-secrets include keys in the export
(ALPHA Warning) This command is currently in experimental mode.
The node import command imports cluster configuration and cluster nodes from a text file. This file should be created using the node export command.
This command is useful with node whitelist command. With your SSH public key and IP whitelisted by cluster owner you will be able to execute commands and use avalanche-cli to manage this cluster. Please note, that this imported cluster will be considered as EXTERNAL by avalanche-cli so some commands affecting cloud nodes like node create or node destroy will be not applicable for it.
Usage:
avalanche node import [clusterName] [flags]
Flags:
--file string specify the file to export the cluster configuration to -h, --help help for import
(ALPHA Warning) This command is currently in experimental mode.
The node resize command can be used to resize cluster instance size and/or size of the cloud persistent storage attached to the instance. In another words, it can change amount of CPU, memory and disk space available for the cluster nodes.
Please note that disk resize operation can affect disk performance during cloud operation to resize it. Please note that instance resize operation will replace cluster instances one by one, which might affect cluster stability.
Usage:
avalanche node resize [clusterName] [flags]
Flags:
--aws-profile string aws profile to use (default "default") --disk-size string Disk size to resize in Gb (e.g. 1000Gb) -h, --help help for resize --node-type string Node type to resize (e.g. t3.2xlarge)
The network command suite provides a collection of tools for managing local Subnet deployments.
When you deploy a Subnet locally, it runs on a local, multi-node Avalanche network. The blockchain deploy command starts this network in the background. This command suite allows you to shutdown, restart, and clear that network.
This network currently supports multiple, concurrently deployed Subnets.
The network clean command shuts down your local, multi-node network. All deployed Subnets shutdown and delete their state. You can restart the network by deploying a new Subnet configuration.
Usage:
avalanche network clean [flags]
Flags:
--hard Also clean downloaded avalanchego and plugin binaries-h, --help help for clean
The network start command starts a local, multi-node Avalanche network on your machine.
By default, the command loads the default snapshot. If you provide the --snapshot-name flag, the network loads that snapshot instead. The command fails if the local network is already running.
Usage:
avalanche network start [flags]
Flags:
--avalanchego-path string use this avalanchego binary path --avalanchego-version string use this version of avalanchego (ex: v1.17.12) (default "latest")-h, --help help for start --snapshot-name string name of snapshot to use to start the network from (default "default-1654102509")
The network stop command shuts down your local, multi-node network.
All deployed Subnets shutdown gracefully and save their state. If you provide the --snapshot-name flag, the network saves its state under this named snapshot. You can reload this snapshot with network start --snapshot-name <snapshotName>. Otherwise, the network saves to the default snapshot, overwriting any existing state. You can reload the default snapshot with network start.
Usage:
avalanche network stop [flags]
Flags:
-h, --help help for stop --snapshot-name string name of snapshot to use to save network state into (default "default-1654102509")
The transaction sign command signs a multisig transaction.
Usage:
avalanche transaction sign [subnetName] [flags]
Flags:
-h, --help help for sign --input-tx-filepath string Path to the transaction file for signing-k, --key string select the key to use [fuji only]-g, --ledger use ledger instead of key (always true on mainnet, defaults to false on fuji) --ledger-addrs strings use the given ledger addresses
The key command suite provides a collection of tools for creating and managing signing keys. You can use these keys to deploy Subnets to the Fuji Testnet, but these keys are NOT suitable to use in production environments. DO NOT use these keys on Mainnet.
The key create command generates a new private key to use for creating and controlling test Subnets. Keys generated by this command are NOT cryptographically secure enough to use in production environments. DO NOT use these keys on Mainnet.
The command works by generating a secp256 key and storing it with the provided keyName. You can use this key in other commands by providing this keyName.
If you'd like to import an existing key instead of generating one from scratch, provide the --file flag.
Usage:
avalanche key create [keyName] [flags]
Flags:
--file string import the key from an existing key file-f, --force overwrite an existing key with the same name-h, --help help for create
The key delete command deletes an existing signing key.
To delete a key, provide the keyName. The command prompts for confirmation before deleting the key. To skip the confirmation, provide the --force flag.
Usage:
avalanche key delete [keyName] [flags]
Flags:
-f, --force delete the key without confirmation-h, --help help for delete
The key export command exports a created signing key. You can use an exported key in other applications or import it into another instance of Avalanche-CLI.
By default, the tool writes the hex encoded key to stdout. If you provide the --output flag, the command writes the key to a file of your choosing.
Usage:
avalanche key export [keyName] [flags]
Flags:
-h, --help help for export-o, --output string write the key to the provided file path
The key list command prints information for all stored signing keys or for the ledger addresses associated to certain indices.
Usage:
avalanche key list [flags]
Flags:
-a, --all-networks list all network addresses-c, --cchain list C-Chain addresses (default true)-f, --fuji list testnet (fuji) network addresses-h, --help help for list-g, --ledger uints list ledger addresses for the given indices (default [])-l, --local list local network addresses-m, --mainnet list mainnet network addresses --pchain list P-Chain addresses (default true) --subnet string provide balance information for the given subnet (Subnet-Evm based only)-t, --testnet list testnet (fuji) network addresses-n, --use-nano-avax use nano Avax for balances --xchain list X-Chain addresses (default true)
The key transfer command allows to transfer funds between stored keys or ledger addresses.
Usage:
avalanche key transfer [options] [flags]
Flags:
-o, --amount float amount to send or receive (AVAX units)-f, --force avoid transfer confirmation-u, --fuji transfer between testnet (fuji) addresses --fund-p-chain fund P-Chain account on target --fund-x-chain fund X-Chain account on target-h, --help help for transfer-k, --key string key associated to the sender or receiver address-i, --ledger uint32 ledger index associated to the sender or receiver address (default 32768)-l, --local transfer between local network addresses-m, --mainnet transfer between mainnet addresses-g, --receive receive the transfer-r, --receive-recovery-step uint receive step to use for multiple step transaction recovery-s, --send send the transfer-a, --target-addr string receiver address-t, --testnet transfer between testnet (fuji) addresses
%22%2F%3E%3Cpath%20d%3D%22M0%200%20C9.57967371%207.65251279%2016.09243516%2019.06001585%2022%2029.59765625%20C22.97076777%2031.30442209%2023.94154282%2033.01118381%2024.91267395%2034.71774292%20C25.91888594%2036.48895936%2026.92132549%2038.26226312%2027.92285156%2040.03613281%20C30.8854856%2045.27997714%2033.88443718%2050.50299939%2036.87744141%2055.72955322%20C38.55347139%2058.65819617%2040.22601848%2061.58882517%2041.8984375%2064.51953125%20C42.23139832%2065.10296295%2042.56435913%2065.68639465%2042.90740967%2066.2875061%20C44.25432083%2068.64775599%2045.60109509%2071.00808398%2046.94787598%2073.3684082%20C49.29791657%2077.4868721%2051.6485209%2081.6050135%2054%2085.72265625%20C54.33152069%2086.30319763%2054.66304138%2086.88373901%2055.00460815%2087.48187256%20C59.79376544%2095.86643156%2064.6070903%20104.23679468%2069.4375%20112.59765625%20C76.29116175%20124.46052518%2083.09519017%20136.35133428%2089.88464355%20148.25100708%20C92.30303571%20152.48874481%2094.72669834%20156.72344179%2097.15234375%20160.95703125%20C111.28453595%20185.6283462%20111.28453595%20185.6283462%20117.85693359%20197.63330078%20C118.94185692%20199.60557667%20120.04247671%20201.56850604%20121.14453125%20203.53125%20C134.3278359%20227.24675421%20140.08023678%20256.86051391%20132.8984375%20283.578125%20C132.58132813%20284.57457031%20132.26421875%20285.57101562%20131.9375%20286.59765625%20C131.62039063%20287.66628906%20131.30328125%20288.73492188%20130.9765625%20289.8359375%20C124.77971652%20308.88794269%20113.86972281%20326.32617576%20103.9375%20343.59765625%20C101.95654421%20347.05496678%2099.97827372%20350.51381054%2098%20353.97265625%20C97.27127686%20355.24484009%2097.27127686%20355.24484009%2096.52783203%20356.54272461%20C92.01504971%20364.43234355%2087.58080922%20372.3651695%2083.14868164%20380.30029297%20C78.96972408%20387.77467349%2074.73737536%20395.21659012%2070.4765625%20402.64453125%20C66.58593006%20409.437699%2062.75490463%20416.26311088%2058.9375%20423.09765625%20C54.13863892%20431.68826671%2049.29649811%20440.2519291%2044.40405273%20448.78955078%20C39.08920272%20458.06743601%2033.83383643%20467.37867998%2028.57861328%20476.69042969%20C25.86700977%20481.49402603%2023.15209904%20486.29575231%2020.4375%20491.09765625%20C19.35415057%20493.01431382%2018.27081725%20494.93098049%2017.1875%20496.84765625%20C-5.5625%20537.09765625%20-5.5625%20537.09765625%20-28.3125%20577.34765625%20C-28.84883057%20578.29656738%20-29.38516113%20579.24547852%20-29.93774414%20580.22314453%20C-31.0201993%20582.13821998%20-32.10271875%20584.05325909%20-33.18530273%20585.96826172%20C-35.90760255%20590.78397693%20-38.62875348%20595.60033468%20-41.34765625%20600.41796875%20C-46.54075009%20609.61698689%20-51.74771144%20618.80729072%20-57%20627.97265625%20C-61.34177641%20635.54927102%20-65.62051312%20643.15922277%20-69.875%20650.78515625%20C-76.5540578%20662.74401757%20-83.35780845%20674.62761627%20-90.24414062%20686.46826172%20C-91.44103346%20688.528113%20-92.63512118%20690.5895972%20-93.82617188%20692.65283203%20C-100.39739411%20704.03312978%20-107.0395479%20715.17356974%20-115.0625%20725.59765625%20C-115.61679687%20726.33628906%20-116.17109375%20727.07492187%20-116.7421875%20727.8359375%20C-131.24199733%20745.83445766%20-155.75846169%20757.96882462%20-178.0625%20761.59765625%20C-178.94684754%20761.75948993%20-179.83119509%20761.9213236%20-180.74234104%20762.08806133%20C-191.79439704%20763.92571679%20-202.70915382%20763.88719248%20-213.88452148%20763.87231445%20C-216.0592669%20763.87666942%20-218.23401079%20763.88185516%20-220.40875244%20763.88780212%20C-226.27859555%20763.90111756%20-232.14837399%20763.90177925%20-238.01822925%20763.89923882%20C-242.93350233%20763.89816424%20-247.84876258%20763.90306478%20-252.7640329%20763.90784425%20C-264.36621737%20763.91891319%20-275.96836945%20763.91939127%20-287.57055664%20763.91333008%20C-299.50846674%20763.9072891%20-311.44625901%20763.91961055%20-323.38414901%20763.94090015%20C-333.66484303%20763.95855489%20-343.94549967%20763.96451149%20-354.22620827%20763.9612624%20C-360.35276217%20763.95945592%20-366.47923196%20763.96202232%20-372.60577202%20763.97597694%20C-378.36873325%20763.98861419%20-384.13151157%20763.98655565%20-389.89447021%20763.97356606%20C-391.99901964%20763.97121371%20-394.10358217%20763.97388633%20-396.20811653%20763.98218918%20C-430.15757588%20764.10638341%20-430.15757588%20764.10638341%20-442.30859375%20752.44140625%20C-448.49627886%20745.44761904%20-451.93084891%20736.95398803%20-452.5625%20727.59765625%20C-451.03997373%20707.00125923%20-435.81249137%20686.88411582%20-425.74316406%20669.50439453%20C-422.53912356%20663.9629497%20-419.36420035%20658.40480138%20-416.1875%20652.84765625%20C-415.84887939%20652.25569458%20-415.51025879%20651.66373291%20-415.16137695%20651.05383301%20C-409.74165486%20641.57737482%20-404.3891309%20632.064786%20-399.06640625%20622.53344727%20C-393.46768837%20612.51489871%20-387.77182157%20602.55345485%20-382.0625%20592.59765625%20C-379.43572086%20588.01533979%20-376.81041488%20583.43218541%20-374.1875%20578.84765625%20C-373.84869812%20578.25551331%20-373.50989624%20577.66337036%20-373.16082764%20577.05328369%20C-367.74345658%20567.58069523%20-362.39245313%20558.07241756%20-357.07299805%20548.54443359%20C-352.93321365%20541.13502938%20-348.74202558%20533.75671211%20-344.52148438%20526.39306641%20C-340.92770875%20520.12057494%20-337.3639296%20513.83170979%20-333.8125%20507.53515625%20C-329.28478377%20499.50868801%20-324.72497048%20491.50110522%20-320.14526367%20483.50421143%20C-314.65400157%20473.91552696%20-309.19990809%20464.30775859%20-303.8125%20454.66015625%20C-297.63463944%20443.5973552%20-291.36585281%20432.58931443%20-285.0625%20421.59765625%20C-282.43572086%20417.01533979%20-279.81041488%20412.43218541%20-277.1875%20407.84765625%20C-276.84869812%20407.25551331%20-276.50989624%20406.66337036%20-276.16082764%20406.05328369%20C-270.74133517%20396.57698582%20-265.38900692%20387.06456399%20-260.06640625%20377.53344727%20C-254.46768837%20367.51489871%20-248.77182157%20357.55345485%20-243.0625%20347.59765625%20C-240.43572086%20343.01533979%20-237.81041488%20338.43218541%20-235.1875%20333.84765625%20C-234.84869812%20333.25551331%20-234.50989624%20332.66337036%20-234.16082764%20332.05328369%20C-228.74345658%20322.58069523%20-223.39245313%20313.07241756%20-218.07299805%20303.54443359%20C-213.93321365%20296.13502938%20-209.74202558%20288.75671211%20-205.52148438%20281.39306641%20C-201.92770875%20275.12057494%20-198.3639296%20268.83170979%20-194.8125%20262.53515625%20C-190.28478377%20254.50868801%20-185.72497048%20246.50110522%20-181.14526367%20238.50421143%20C-175.65400157%20228.91552696%20-170.19990809%20219.30775859%20-164.8125%20209.66015625%20C-158.63463944%20198.5973552%20-152.36585281%20187.58931443%20-146.0625%20176.59765625%20C-143.43572086%20172.01533979%20-140.81041488%20167.43218541%20-138.1875%20162.84765625%20C-137.84869812%20162.25551331%20-137.50989624%20161.66337036%20-137.16082764%20161.05328369%20C-131.74133517%20151.57698582%20-126.38900692%20142.06456399%20-121.06640625%20132.53344727%20C-115.46768837%20122.51489871%20-109.77182157%20112.55345485%20-104.0625%20102.59765625%20C-101.4357208%2098.01533968%20-98.8105647%2093.43209975%20-96.1875%2088.84765625%20C-95.84803345%2088.2545163%20-95.50856689%2087.66137634%20-95.15881348%2087.05026245%20C-90.36847658%2078.67683425%20-85.63389529%2070.27424408%20-80.9375%2061.84765625%20C-46.67690615%200.4620628%20-46.67690615%200.4620628%20-31.26953125%20-5.04296875%20C-20.31867082%20-6.8261177%20-9.3223962%20-6.33852317%200%200%20Z%20%22%20fill%3D%22%23FEFEFE%22%20transform%3D%22translate(773.0625%2C287.40234375)%22%2F%3E%3Cpath%20d%3D%22M0%200%20C10.1444424%208.57903677%2016.81475259%2019.9618642%2023.58203125%2031.24609375%20C24.32321606%2032.47434874%2025.06451063%2033.70253749%2025.8059082%2034.93066406%20C32.60475639%2046.22129909%2039.18222711%2057.63773266%2045.73291016%2069.07373047%20C48.59797705%2074.06077913%2051.49428767%2079.02944211%2054.39453125%2083.99609375%20C54.96067139%2084.96579102%2055.52681152%2085.93548828%2056.11010742%2086.93457031%20C61.46376222%2096.09771483%2066.83332607%20105.25154169%2072.20263672%20114.40551758%20C77.21855001%20122.95801761%2082.21870465%20131.51958875%2087.2109375%20140.0859375%20C91.80111111%20147.95928769%2096.40840309%20155.82250712%20101.01953125%20163.68359375%20C107.40216205%20174.56524228%20113.77016585%20185.45527524%20120.12109375%20196.35546875%20C122.42334249%20200.30635609%20124.73113742%20204.2539313%20127.04296875%20208.19921875%20C159.73982983%20264.02839981%20159.73982983%20264.02839981%20157.05859375%20278.70703125%20C154.19131834%20289.4002819%20148.89314961%20297.24420371%20139.51953125%20303.18359375%20C130.02899048%20308.47639533%20118.20887417%20308.48379213%20107.57913208%20308.43756104%20C106.45154759%20308.44068102%20105.32396311%20308.443801%20104.16220939%20308.44701552%20C100.42335167%20308.45492597%2096.68465941%20308.44869912%2092.94580078%20308.44238281%20C90.24903902%20308.4450958%2087.55228826%20308.44858678%2084.85552979%20308.45300293%20C78.31435279%20308.46185729%2071.7732219%20308.45999249%2065.23204316%20308.45417765%20C59.91068197%20308.44964473%2054.58933361%20308.44905528%2049.26797104%20308.45122528%20C48.1281098%20308.45168498%2048.1281098%20308.45168498%2046.96522107%20308.45215397%20C45.42103498%20308.45279348%2043.87684889%20308.4534419%2042.33266281%20308.45409915%20C27.88037539%20308.45979105%2013.42811342%20308.45326288%20-1.02416982%20308.44249842%20C-13.39714809%20308.43356756%20-25.77008881%20308.43511332%20-38.14306641%20308.44433594%20C-52.54363723%20308.455065%20-66.94418579%20308.45923805%20-81.34476006%20308.45311141%20C-82.88359904%20308.45247438%20-84.42243802%20308.45184563%20-85.96127701%20308.45122528%20C-86.71822592%20308.45091673%20-87.47517483%20308.45060818%20-88.25506159%20308.45029028%20C-93.56264374%20308.44857096%20-98.87021165%20308.45146196%20-104.1777916%20308.45618439%20C-110.65670636%20308.46182277%20-117.13557273%20308.46021527%20-123.61448203%20308.4496229%20C-126.91359616%20308.4444051%20-130.21261427%20308.44333835%20-133.51173019%20308.4489212%20C-173.42644255%20308.51020937%20-173.42644255%20308.51020937%20-185.16796875%20298.24609375%20C-192.59310903%20290.07843944%20-196.31528206%20280.75390817%20-196.01953125%20269.73046875%20C-194.73735881%20261.29414576%20-191.69973188%20254.02511874%20-187.66796875%20246.55859375%20C-186.95217651%20245.21341675%20-186.95217651%20245.21341675%20-186.22192383%20243.84106445%20C-180.83642466%20233.82042666%20-175.06683817%20224.02357184%20-169.27880859%20214.23193359%20C-166.32636433%20209.22728804%20-163.4047795%20204.20471146%20-160.48046875%20199.18359375%20C-159.31267209%20197.18088922%20-158.14470329%20195.17828507%20-156.9765625%20193.17578125%20C-156.1100708%20191.69029785%20-156.1100708%20191.69029785%20-155.22607422%20190.17480469%20C-153.49035285%20187.20053081%20-151.7531795%20184.22710953%20-150.015625%20181.25390625%20C-144.01269816%20170.97826818%20-138.03859087%20160.68720812%20-132.10546875%20150.37109375%20C-126.96384527%20141.43489201%20-121.75067413%20132.54453762%20-116.48046875%20123.68359375%20C-108.69199612%20110.58621307%20-101.06855836%2097.39781826%20-93.48046875%2084.18359375%20C-83.87367925%2067.45391873%20-74.18383229%2050.78053992%20-64.29052734%2034.21875%20C-62.63380902%2031.44071895%20-60.98791977%2028.65656081%20-59.34375%2025.87109375%20C-43.49211467%20-0.80308423%20-43.49211467%20-0.80308423%20-30.16796875%20-4.44921875%20C-19.93225133%20-5.8477034%20-8.61212062%20-6.30651353%200%200%20Z%20%22%20fill%3D%22%23FEFEFE%22%20transform%3D%22translate(1030.48046875%2C742.81640625)%22%2F%3E%3C%2Fsvg%3E)