11---
2- title : Reference
3- description : Comprehensive auto-generated reference for the Aztec CLI command-line interface with all commands and options.
2+ title : Aztec CLI Reference
3+ description : Comprehensive auto-generated reference for the Aztec CLI Reference command-line interface with all commands and options.
44tags : [cli, reference, autogenerated]
5- sidebar_position : 2
5+ sidebar_position : 1
66---
77
88# Aztec CLI Reference
99
1010* This documentation is auto-generated from the ` aztec ` CLI help output.*
1111
12- * Generated: Tue Nov 11 00:40:17 HKT 2025*
12+
13+ * Generated: Wed 24 Dec 2025 17:46:59 UTC*
1314
1415* Command: ` aztec ` *
1516
@@ -617,6 +618,7 @@ Options:
617618 deployment (default: 0)
618619 -c, --l1-chain-id <number> Chain ID of the ethereum host (default:
619620 31337, env: L1_CHAIN_ID)
621+ --salt <number> The optional salt to use in deployment
620622 --json Output the contract addresses in JSON
621623 format
622624 --test-accounts Populate genesis state with initial fee
@@ -1404,19 +1406,27 @@ Options:
14041406 Base URLs for snapshots index, comma-separated.
14051407 * Environment: ` $SYNC_SNAPSHOTS_URLS ` *
14061408
1407- ** LOCAL NETWORK**
1409+ - ` --fisherman-mode `
1410+ Whether to run in fisherman mode.
1411+ * Environment: ` $FISHERMAN_MODE ` *
1412+
1413+ ** SANDBOX**
14081414
1409- - ` --local-network `
1410- Starts Aztec Local Network
1415+ - ` --sandbox `
1416+ Starts Aztec Sandbox
14111417
1412- - ` --local-network .noPXE `
1413- Do not expose PXE service on local network start
1418+ - ` --sandbox .noPXE `
1419+ Do not expose PXE service on sandbox start
14141420 * Environment: ` $NO_PXE ` *
14151421
1416- - ` --local-network .l1Mnemonic <value> ` (default: ` test test test test test test test test test test test junk ` )
1422+ - ` --sandbox .l1Mnemonic <value> ` (default: ` test test test test test test test test test test test junk ` )
14171423 Mnemonic for L1 accounts. Will be used
14181424 * Environment: ` $MNEMONIC ` *
14191425
1426+ - ` --sandbox.deployAztecContractsSalt <value> `
1427+ Numeric salt for deploying L1 Aztec contracts before starting the sandbox. Needs mnemonic or private key to be set.
1428+ * Environment: ` $DEPLOY_AZTEC_CONTRACTS_SALT ` *
1429+
14201430** API**
14211431
14221432- ` --port <value> ` (default: ` 8080 ` )
@@ -1530,6 +1540,14 @@ Options:
15301540- ` --archiver.skipValidateBlockAttestations <value> `
15311541 Whether to skip validating block attestations (use only for testing).
15321542
1543+ - ` --archiver.maxAllowedEthClientDriftSeconds <value> ` (default: ` 300 ` )
1544+ Maximum allowed drift in seconds between the Ethereum client and current time.
1545+ * Environment: ` $MAX_ALLOWED_ETH_CLIENT_DRIFT_SECONDS ` *
1546+
1547+ - ` --archiver.ethereumAllowNoDebugHosts <value> ` (default: ` true ` )
1548+ Whether to allow starting the archiver without debug/trace method support on Ethereum hosts
1549+ * Environment: ` $ETHEREUM_ALLOW_NO_DEBUG_HOSTS ` *
1550+
15331551** SEQUENCER**
15341552
15351553- ` --sequencer `
@@ -1637,6 +1655,9 @@ Options:
16371655- ` --sequencer.injectFakeAttestation <value> `
16381656 Inject a fake attestation (for testing only)
16391657
1658+ - ` --sequencer.shuffleAttestationOrdering <value> `
1659+ Shuffle attestation ordering to create invalid ordering (for testing only)
1660+
16401661- ` --sequencer.txPublicSetupAllowList <value> `
16411662 The list of functions calls allowed to run in setup
16421663 * Environment: ` $TX_PUBLIC_SETUP_ALLOWLIST ` *
@@ -1657,6 +1678,10 @@ Options:
16571678 True to use publishers in invalid states (timed out, cancelled, etc) if no other is available
16581679 * Environment: ` $SEQ_PUBLISHER_ALLOW_INVALID_STATES ` *
16591680
1681+ - ` --sequencer.publisherForwarderAddress <value> `
1682+ Address of the forwarder contract to wrap all L1 transactions through (for testing purposes only)
1683+ * Environment: ` $SEQ_PUBLISHER_FORWARDER_ADDRESS ` *
1684+
16601685- ` --sequencer.blobSinkUrl <value> `
16611686 The URL of the blob sink
16621687 * Environment: ` $BLOB_SINK_URL ` *
@@ -1743,6 +1768,10 @@ Options:
17431768 True to use publishers in invalid states (timed out, cancelled, etc) if no other is available
17441769 * Environment: ` $PROVER_PUBLISHER_ALLOW_INVALID_STATES ` *
17451770
1771+ - ` --proverNode.publisherForwarderAddress <value> `
1772+ Address of the forwarder contract to wrap all L1 transactions through (for testing purposes only)
1773+ * Environment: ` $PROVER_PUBLISHER_FORWARDER_ADDRESS ` *
1774+
17461775- ` --proverNode.publisherPrivateKeys <value> `
17471776 The private keys to be used by the publisher.
17481777 * Environment: ` $PROVER_PUBLISHER_PRIVATE_KEYS ` *
@@ -2161,7 +2190,7 @@ Options:
21612190 A list of metric prefixes to publicly export
21622191 * Environment: ` $PUBLIC_OTEL_INCLUDE_METRICS ` *
21632192
2164- - ` --tel.publicMetricsOptOut <value> `
2193+ - ` --tel.publicMetricsOptOut <value> ` (default: ` true ` )
21652194 Whether to opt out of sharing optional telemetry
21662195 * Environment: ` $PUBLIC_OTEL_OPT_OUT ` *
21672196
@@ -2336,8 +2365,7 @@ Usage: aztec update [options] [projectPath]
23362365Updates Nodejs and Noir dependencies
23372366
23382367Arguments:
2339- projectPath Path to the project directory (default:
2340- "/Users/aztec/code/aztec-packages/docs")
2368+ projectPath Path to the project directory
23412369
23422370Options:
23432371 --contract [paths...] Paths to contracts to update dependencies (default:
0 commit comments