Skip to main content
Version: Devnet (v4.0.0-devnet.2-patch.0)

Aztec CLI Reference

This documentation is auto-generated from the aztec CLI help output.

Generated: Thu 19 Feb 2026 01:19:47 UTC

Command: aztec

Table of Contents​

aztec​

Aztec command line interface

Usage:

aztec [options] [command]

Available Commands:

  • add-l1-validator [options] - Adds a validator to the L1 rollup contract via a direct deposit.
  • advance-epoch [options] - Use L1 cheat codes to warp time until the next epoch.
  • block-number [options] - Gets the current Aztec L2 block number.
  • bridge-erc20 [options] <amount> <recipient> - Bridges ERC20 tokens to L2.
  • codegen [options] <noir-abi-path> - Validates and generates an Aztec Contract ABI from Noir ABI.
  • compute-genesis-values [options] - Computes genesis values (VK tree root, protocol contracts hash, genesis archive root).
  • compute-selector <functionSignature> - Given a function signature, it computes a selector
  • debug-rollup [options] - Debugs the rollup contract.
  • decode-enr <enr> - Decodes an ENR record
  • deploy-l1-contracts [options] - Deploys all necessary Ethereum contracts for Aztec.
  • deploy-new-rollup [options] - Deploys a new rollup contract and adds it to the registry (if you are the owner).
  • deposit-governance-tokens [options] - Deposits governance tokens to the governance contract.
  • example-contracts - Lists the example contracts available to deploy from @aztec/noir-contracts.js
  • execute-governance-proposal [options] - Executes a governance proposal.
  • fast-forward-epochs [options] - Fast forwards the epoch of the L1 rollup contract.
  • generate-bls-keypair [options] - Generate a BLS keypair with convenience flags
  • generate-bootnode-enr [options] <privateKey> <p2pIp> <p2pPort> - Generates the encoded ENR record for a bootnode.
  • generate-keys [options] - Generates encryption and signing private keys.
  • generate-l1-account [options] - Generates a new private key for an account on L1.
  • generate-p2p-private-key - Generates a LibP2P peer private key.
  • generate-secret-and-hash - Generates an arbitrary secret (Fr), and its hash (using aztec-nr defaults)
  • get-block [options] [blockNumber] - Gets info for a given block or latest.
  • get-canonical-sponsored-fpc-address - Gets the canonical SponsoredFPC address for this any testnet running on the same version as this CLI
  • get-current-min-fee [options] - Gets the current base fee.
  • get-l1-addresses [options] - Gets the addresses of the L1 contracts.
  • get-l1-balance [options] <who> - Gets the balance of an ERC token in L1 for the given Ethereum address.
  • get-l1-to-l2-message-witness [options] - Gets a L1 to L2 message witness.
  • get-logs [options] - Gets all the public logs from an intersection of all the filter params.
  • get-node-info [options] - Gets the information of an Aztec node from a PXE or directly from an Aztec node.
  • help [command] - display help for command
  • inspect-contract <contractArtifactFile> - Shows list of external callable functions for a contract
  • migrate-ha-db - Run validator-ha-signer database migrations
  • parse-parameter-struct [options] <encodedString> - Helper for parsing an encoded string into a contract's parameter struct.
  • preload-crs - Preload the points data needed for proving and verifying
  • propose-with-lock [options] - Makes a proposal to governance with a lock
  • prune-rollup [options] - Prunes the pending chain on the rollup contract.
  • remove-l1-validator [options] - Removes a validator to the L1 rollup contract.
  • sequencers [options] <command> [who] - Manages or queries registered sequencers on the L1 rollup contract.
  • setup-protocol-contracts [options] - Bootstrap the blockchain by initializing all the protocol contracts
  • start [options] - Starts Aztec modules. Options for each module can be set as key-value pairs (e.g. "option1=value1,option2=value2") or as environment variables.
  • trigger-seed-snapshot [options] - Triggers a seed snapshot for the next epoch.
  • update [options] [projectPath] - Updates Nodejs and Noir dependencies
  • validator-keys|valKeys - Manage validator keystores for node operators
  • vote-on-governance-proposal [options] - Votes on a governance proposal.

Options:

  • -V --version - output the version number
  • -h --help - display help for command

Subcommands​

aztec add-l1-validator​

Adds a validator to the L1 rollup contract via a direct deposit.

Usage:

aztec add-l1-validator [options]

Options:

  • --l1-rpc-urls <string> - List of Ethereum host URLs. Chain identifiers
  • --network <string> - Network to execute against (env: NETWORK)
  • -pk --private-key <string> - The private key to use sending the transaction
  • -m --mnemonic <string> - The mnemonic to use sending the transaction
  • -c --l1-chain-id <number> - Chain ID of the ethereum host (default: 31337,
  • --attester <address> - ethereum address of the attester
  • --withdrawer <address> - ethereum address of the withdrawer
  • --bls-secret-key <string> - The BN254 scalar field element used as a secret
  • --move-with-latest-rollup - Whether to move with the latest rollup (default:
  • --rollup <string> - Rollup contract address
  • -h --help - display help for command

aztec advance-epoch​

Use L1 cheat codes to warp time until the next epoch.

Usage:

aztec advance-epoch [options]

Options:

  • --l1-rpc-urls <string> - List of Ethereum host URLs. Chain identifiers
  • -n --node-url <string> - URL of the Aztec node (default:
  • -h --help - display help for command

aztec block-number​

Gets the current Aztec L2 block number.

Usage:

aztec block-number [options]

Options:

  • -n --node-url <string> - URL of the Aztec node (default:
  • -h --help - display help for command

aztec bridge-erc20​

Bridges ERC20 tokens to L2.

Usage:

aztec bridge-erc20 [options] <amount> <recipient>

Options:

  • --l1-rpc-urls <string> - List of Ethereum host URLs. Chain identifiers
  • -m --mnemonic <string> - The mnemonic to use for deriving the Ethereum
  • --mint - Mint the tokens on L1 (default: false)
  • --private - If the bridge should use the private flow
  • -c --l1-chain-id <number> - Chain ID of the ethereum host (default: 31337,
  • -t --token <string> - The address of the token to bridge
  • -p --portal <string> - The address of the portal contract
  • -f --faucet <string> - The address of the faucet contract (only used if
  • --l1-private-key <string> - The private key to use for deployment
  • --json - Output the claim in JSON format
  • -h --help - display help for command

aztec codegen​

Validates and generates an Aztec Contract ABI from Noir ABI.

Usage:

aztec codegen [options] <noir-abi-path>

Options:

  • -o --outdir <path> - Output folder for the generated code.
  • -f --force - Force code generation even when the contract has not
  • -h --help - display help for command

aztec compute-genesis-values​

Computes genesis values (VK tree root, protocol contracts hash, genesis archive

Usage:

aztec compute-genesis-values [options]

Options:

  • --test-accounts <boolean> - Include initial test accounts in genesis state
  • --sponsored-fpc <boolean> - Include sponsored FPC contract in genesis state
  • -h --help - display help for command

aztec compute-selector​

Given a function signature, it computes a selector

Usage:

aztec compute-selector [options] <functionSignature>

Options:

  • -h --help - display help for command

aztec debug-rollup​

Debugs the rollup contract.

Usage:

aztec debug-rollup [options]

Options:

  • --l1-rpc-urls <string> - List of Ethereum host URLs. Chain identifiers
  • -c --l1-chain-id <number> - Chain ID of the ethereum host (default: 31337,
  • --rollup <address> - ethereum address of the rollup contract
  • -h --help - display help for command

aztec decode-enr​

Decodes and ENR record

Usage:

aztec decode-enr [options] <enr>

Options:

  • -h --help - display help for command

aztec deploy-l1-contracts​

Deploys all necessary Ethereum contracts for Aztec.

Usage:

aztec deploy-l1-contracts [options]

Options:

  • --l1-rpc-urls <string> - List of Ethereum host URLs. Chain identifiers
  • -pk --private-key <string> - The private key to use for deployment
  • --validators <string> - Comma separated list of validators
  • -m --mnemonic <string> - The mnemonic to use in deployment (default:
  • -i --mnemonic-index <number> - The index of the mnemonic to use in deployment
  • -c --l1-chain-id <number> - Chain ID of the ethereum host (default: 31337,
  • --json - Output the contract addresses in JSON format
  • --test-accounts - Populate genesis state with initial fee juice
  • --sponsored-fpc - Populate genesis state with a testing
  • --real-verifier - Deploy the real verifier (default: false)
  • --existing-token <address> - Use an existing ERC20 for both fee and staking
  • -h --help - display help for command

aztec deploy-new-rollup​

Deploys a new rollup contract and adds it to the registry (if you are the

Usage:

aztec deploy-new-rollup [options]

Options:

  • -r --registry-address <string> - The address of the registry contract
  • --l1-rpc-urls <string> - List of Ethereum host URLs. Chain
  • -pk --private-key <string> - The private key to use for deployment
  • --validators <string> - Comma separated list of validators
  • -m --mnemonic <string> - The mnemonic to use in deployment (default:
  • -i --mnemonic-index <number> - The index of the mnemonic to use in
  • -c --l1-chain-id <number> - Chain ID of the ethereum host (default:
  • --json - Output the contract addresses in JSON format
  • --test-accounts - Populate genesis state with initial fee
  • --sponsored-fpc - Populate genesis state with a testing
  • --real-verifier - Deploy the real verifier (default: false)
  • -h --help - display help for command

aztec deposit-governance-tokens​

Deposits governance tokens to the governance contract.

Usage:

aztec deposit-governance-tokens [options]

Options:

  • -r --registry-address <string> - The address of the registry contract
  • --recipient <string> - The recipient of the tokens
  • -a --amount <string> - The amount of tokens to deposit
  • --mint - Mint the tokens on L1 (default: false)
  • --l1-rpc-urls <string> - List of Ethereum host URLs. Chain
  • -c --l1-chain-id <number> - Chain ID of the ethereum host (default:
  • -p --private-key <string> - The private key to use to deposit
  • -m --mnemonic <string> - The mnemonic to use to deposit (default:
  • -i --mnemonic-index <number> - The index of the mnemonic to use to deposit
  • -h --help - display help for command

aztec example-contracts​

Lists the example contracts available to deploy from @aztec/noir-contracts.js

Usage:

aztec example-contracts [options]

Options:

  • -h --help - display help for command

aztec execute-governance-proposal​

Executes a governance proposal.

Usage:

aztec execute-governance-proposal [options]

Options:

  • -p --proposal-id <string> - The ID of the proposal
  • -r --registry-address <string> - The address of the registry contract
  • --wait <boolean> - Whether to wait until the proposal is
  • --l1-rpc-urls <string> - List of Ethereum host URLs. Chain
  • -c --l1-chain-id <number> - Chain ID of the ethereum host (default:
  • -pk --private-key <string> - The private key to use to vote
  • -m --mnemonic <string> - The mnemonic to use to vote (default: "test
  • -i --mnemonic-index <number> - The index of the mnemonic to use to vote
  • -h --help - display help for command

aztec fast-forward-epochs​

Help for this command is currently unavailable due to a technical issue with option serialization.

aztec generate-bls-keypair​

Generate a BLS keypair with convenience flags

Usage:

aztec generate-bls-keypair [options]

Options:

  • --mnemonic <mnemonic> - Mnemonic for BLS derivation
  • --ikm <hex> - Initial keying material for BLS (alternative to
  • --bls-path <path> - EIP-2334 path (default m/12381/3600/0/0/0)
  • --g2 - Derive on G2 subgroup
  • --compressed - Output compressed public key
  • --json - Print JSON output to stdout
  • --out <file> - Write output to file
  • -h --help - display help for command

aztec generate-bootnode-enr​

Generates the encoded ENR record for a bootnode.

Usage:

aztec generate-bootnode-enr [options] <privateKey> <p2pIp> <p2pPort>

Options:

  • -c --l1-chain-id <number> - Chain ID of the ethereum host (default: 31337,
  • -h --help - display help for command

aztec generate-keys​

Generates and encryption and signing private key pair.

Usage:

aztec generate-keys [options]

Options:

  • --json - Output the keys in JSON format
  • -h --help - display help for command

aztec generate-l1-account​

Generates a new private key for an account on L1.

Usage:

aztec generate-l1-account [options]

Options:

  • --json - Output the private key in JSON format
  • -h --help - display help for command

aztec generate-p2p-private-key​

Generates a private key that can be used for running a node on a LibP2P

Usage:

aztec generate-p2p-private-key [options]

Options:

  • -h --help - display help for command

aztec generate-secret-and-hash​

Generates an arbitrary secret (Fr), and its hash (using aztec-nr defaults)

Usage:

aztec generate-secret-and-hash [options]

Options:

  • -h --help - display help for command

aztec get-block​

Gets info for a given block or latest.

Usage:

aztec get-block [options] [blockNumber]

Options:

  • -n --node-url <string> - URL of the Aztec node (default:
  • -h --help - display help for command

aztec get-canonical-sponsored-fpc-address​

Gets the canonical SponsoredFPC address for this any testnet running on the

Usage:

aztec get-canonical-sponsored-fpc-address [options]

Options:

  • -h --help - display help for command

aztec get-current-min-fee​

Gets the current base fee.

Usage:

aztec get-current-min-fee [options]

Options:

  • -n --node-url <string> - URL of the Aztec node (default:
  • -h --help - display help for command

aztec get-l1-addresses​

Gets the addresses of the L1 contracts.

Usage:

aztec get-l1-addresses [options]

Options:

  • -r --registry-address <string> - The address of the registry contract
  • --l1-rpc-urls <string> - List of Ethereum host URLs. Chain
  • -v --rollup-version <number> - The version of the rollup
  • -c --l1-chain-id <number> - Chain ID of the ethereum host (default:
  • --json - Output the addresses in JSON format
  • -h --help - display help for command

aztec get-l1-balance​

Gets the balance of an ERC token in L1 for the given Ethereum address.

Usage:

aztec get-l1-balance [options] <who>

Options:

  • --l1-rpc-urls <string> - List of Ethereum host URLs. Chain identifiers
  • -t --token <string> - The address of the token to check the balance of
  • -c --l1-chain-id <number> - Chain ID of the ethereum host (default: 31337,
  • --json - Output the balance in JSON format
  • -h --help - display help for command

aztec get-l1-to-l2-message-witness​

Gets a L1 to L2 message witness.

Usage:

aztec get-l1-to-l2-message-witness [options]

Options:

  • -ca --contract-address <address> - Aztec address of the contract.
  • --message-hash <messageHash> - The L1 to L2 message hash.
  • --secret <secret> - The secret used to claim the L1 to L2
  • -n --node-url <string> - URL of the Aztec node (default:
  • -h --help - display help for command

aztec get-logs​

Gets all the public logs from an intersection of all the filter params.

Usage:

aztec get-logs [options]

Options:

  • -tx --tx-hash <txHash> - A transaction hash to get the receipt for.
  • -fb --from-block <blockNum> - Initial block number for getting logs
  • -tb --to-block <blockNum> - Up to which block to fetch logs (defaults
  • -ca --contract-address <address> - Contract address to filter logs by.
  • -n --node-url <string> - URL of the Aztec node (default:
  • --follow - If set, will keep polling for new logs
  • -h --help - display help for command

aztec get-node-info​

Gets the information of an Aztec node from a PXE or directly from an Aztec

Usage:

aztec get-node-info [options]

Options:

  • --json - Emit output as json
  • -n --node-url <string> - URL of the Aztec node (default:
  • -h --help - display help for command

aztec inspect-contract​

Shows list of external callable functions for a contract

Usage:

aztec inspect-contract [options] <contractArtifactFile>

Options:

  • -h --help - display help for command

aztec migrate-ha-db​

Run validator-ha-signer database migrations

Usage:

aztec migrate-ha-db [options] [command]

Available Commands:

  • down [options] - Rollback the last migration
  • help [command] - display help for command
  • up [options] - Apply pending migrations

Options:

  • -h --help - display help for command

Subcommands​

aztec migrate-ha-db down​

Rollback the last migration

Usage:

aztec migrate-ha-db down [options]

Options:

  • --database-url <string> - PostgreSQL connection string
  • --verbose - Enable verbose output (default: false)
  • -h --help - display help for command

aztec migrate-ha-db up​

Apply pending migrations

Usage:

aztec migrate-ha-db up [options]

Options:

  • --database-url <string> - PostgreSQL connection string
  • --verbose - Enable verbose output (default: false)
  • -h --help - display help for command

aztec parse-parameter-struct​

Helper for parsing an encoded string into a contract's parameter struct.

Usage:

aztec parse-parameter-struct [options] <encodedString>

Options:

  • -c --contract-artifact <fileLocation> - A compiled Aztec.nr contract's ABI in JSON format or name of a contract ABI exported by @aztec/noir-contracts.js
  • -p --parameter <parameterName> - The name of the struct parameter to decode into
  • -h --help - display help for command

aztec preload-crs​

Preload the points data needed for proving and verifying

Usage:

aztec preload-crs [options]

Options:

  • -h --help - display help for command

aztec propose-with-lock​

Makes a proposal to governance with a lock

Usage:

aztec propose-with-lock [options]

Options:

  • -r --registry-address <string> - The address of the registry contract
  • -p --payload-address <string> - The address of the payload contract
  • --l1-rpc-urls <string> - List of Ethereum host URLs. Chain
  • -c --l1-chain-id <number> - Chain ID of the ethereum host (default:
  • -pk --private-key <string> - The private key to use to propose
  • -m --mnemonic <string> - The mnemonic to use to propose (default:
  • -i --mnemonic-index <number> - The index of the mnemonic to use to propose
  • --json - Output the proposal ID in JSON format
  • -h --help - display help for command

aztec prune-rollup​

Prunes the pending chain on the rollup contract.

Usage:

aztec prune-rollup [options]

Options:

  • --l1-rpc-urls <string> - List of Ethereum host URLs. Chain identifiers
  • -pk --private-key <string> - The private key to use for deployment
  • -m --mnemonic <string> - The mnemonic to use in deployment (default:
  • -c --l1-chain-id <number> - Chain ID of the ethereum host (default: 31337,
  • --rollup <address> - ethereum address of the rollup contract
  • -h --help - display help for command

aztec remove-l1-validator​

Removes a validator to the L1 rollup contract.

Usage:

aztec remove-l1-validator [options]

Options:

  • --l1-rpc-urls <string> - List of Ethereum host URLs. Chain identifiers
  • -pk --private-key <string> - The private key to use for deployment
  • -m --mnemonic <string> - The mnemonic to use in deployment (default:
  • -c --l1-chain-id <number> - Chain ID of the ethereum host (default: 31337,
  • --validator <address> - ethereum address of the validator
  • --rollup <address> - ethereum address of the rollup contract
  • -h --help - display help for command

aztec sequencers​

Manages or queries registered sequencers on the L1 rollup contract.

Usage:

aztec sequencers [options] <command> [who]

Options:

  • --l1-rpc-urls <string> - List of Ethereum host URLs. Chain identifiers
  • -m --mnemonic <string> - The mnemonic for the sender of the tx (default:
  • --block-number <number> - Block number to query next sequencer for
  • -n --node-url <string> - URL of the Aztec node (default:
  • -c --l1-chain-id <number> - Chain ID of the ethereum host (default: 31337,
  • -h --help - display help for command

aztec setup-protocol-contracts​

Bootstrap the blockchain by initializing all the protocol contracts

Usage:

aztec setup-protocol-contracts [options]

Options:

  • -n --node-url <string> - URL of the Aztec node (default:
  • --testAccounts - Deploy funded test accounts.
  • --json - Output the contract addresses in JSON format
  • -h --help - display help for command

aztec start​

Options:

  • --bot.minFeePadding <value> -

aztec trigger-seed-snapshot​

Triggers a seed snapshot for the next epoch.

Usage:

aztec trigger-seed-snapshot [options]

Options:

  • -pk --private-key <string> - The private key to use for deployment
  • -m --mnemonic <string> - The mnemonic to use in deployment (default:
  • --rollup <address> - ethereum address of the rollup contract
  • --l1-rpc-urls <string> - List of Ethereum host URLs. Chain identifiers
  • -c --l1-chain-id <number> - Chain ID of the ethereum host (default: 31337,
  • -h --help - display help for command

aztec update​

Updates Nodejs and Noir dependencies

Usage:

aztec update [options] [projectPath]

Options:

  • --contract - [paths...] Paths to contracts to update dependencies (default:
  • --aztec-version <semver> - The version to update Aztec packages to. Defaults
  • -h --help - display help for command

aztec validator-keys|valKeys​

This subcommand does not provide its own help information.

aztec vote-on-governance-proposal​

Votes on a governance proposal.

Usage:

aztec vote-on-governance-proposal [options]

Options:

  • -p --proposal-id <string> - The ID of the proposal
  • -a --vote-amount <string> - The amount of tokens to vote
  • --in-favor <boolean> - Whether to vote in favor of the proposal.
  • --wait <boolean> - Whether to wait until the proposal is active
  • -r --registry-address <string> - The address of the registry contract
  • --l1-rpc-urls <string> - List of Ethereum host URLs. Chain
  • -c --l1-chain-id <number> - Chain ID of the ethereum host (default:
  • -pk --private-key <string> - The private key to use to vote
  • -m --mnemonic <string> - The mnemonic to use to vote (default: "test
  • -i --mnemonic-index <number> - The index of the mnemonic to use to vote
  • -h --help - display help for command