Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions docs/docs-developers/docs/aztec-cli/_category_.json

This file was deleted.

154 changes: 0 additions & 154 deletions docs/docs-developers/docs/aztec-cli/local-network-reference.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/docs-developers/docs/aztec-js/how_to_test.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Testing Aztec.nr contracts with TypeScript
title: Testing Smart Contracts
tags: [contracts, tests]
sidebar_position: 8
description: Learn how to write and run tests for your Aztec.js applications.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This guide shows you how to profile your Aztec transactions to identify bottlene

## Prerequisites

- `aztec` command installed ([see installation](../../../aztec-cli/local-network-reference.md))
- `aztec` command installed ([see installation](../../../../getting_started_on_local_network.md))
- `aztec-wallet` installed
- Aztec contract deployed and ready to test
- Basic understanding of proving and gate counts
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Wallet CLI",
"label": "CLI",
"position": 5,
"collapsible": true,
"collapsed": true
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
---
title: Reference
description: Comprehensive auto-generated reference for the Aztec CLI command-line interface with all commands and options.
title: Aztec CLI Reference
description: Comprehensive auto-generated reference for the Aztec CLI Reference command-line interface with all commands and options.
tags: [cli, reference, autogenerated]
sidebar_position: 2
sidebar_position: 1
---

# Aztec CLI Reference

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

*Generated: Tue Nov 11 00:40:17 HKT 2025*

*Generated: Wed 24 Dec 2025 17:46:59 UTC*

*Command: `aztec`*

Expand Down Expand Up @@ -617,6 +618,7 @@ Options:
deployment (default: 0)
-c, --l1-chain-id <number> Chain ID of the ethereum host (default:
31337, env: L1_CHAIN_ID)
--salt <number> The optional salt to use in deployment
--json Output the contract addresses in JSON
format
--test-accounts Populate genesis state with initial fee
Expand Down Expand Up @@ -1404,19 +1406,27 @@ Options:
Base URLs for snapshots index, comma-separated.
*Environment: `$SYNC_SNAPSHOTS_URLS`*

**LOCAL NETWORK**
- `--fisherman-mode`
Whether to run in fisherman mode.
*Environment: `$FISHERMAN_MODE`*

**SANDBOX**

- `--local-network`
Starts Aztec Local Network
- `--sandbox`
Starts Aztec Sandbox

- `--local-network.noPXE`
Do not expose PXE service on local network start
- `--sandbox.noPXE`
Do not expose PXE service on sandbox start
*Environment: `$NO_PXE`*

- `--local-network.l1Mnemonic <value>` (default: `test test test test test test test test test test test junk`)
- `--sandbox.l1Mnemonic <value>` (default: `test test test test test test test test test test test junk`)
Mnemonic for L1 accounts. Will be used
*Environment: `$MNEMONIC`*

- `--sandbox.deployAztecContractsSalt <value>`
Numeric salt for deploying L1 Aztec contracts before starting the sandbox. Needs mnemonic or private key to be set.
*Environment: `$DEPLOY_AZTEC_CONTRACTS_SALT`*

**API**

- `--port <value>` (default: `8080`)
Expand Down Expand Up @@ -1530,6 +1540,14 @@ Options:
- `--archiver.skipValidateBlockAttestations <value>`
Whether to skip validating block attestations (use only for testing).

- `--archiver.maxAllowedEthClientDriftSeconds <value>` (default: `300`)
Maximum allowed drift in seconds between the Ethereum client and current time.
*Environment: `$MAX_ALLOWED_ETH_CLIENT_DRIFT_SECONDS`*

- `--archiver.ethereumAllowNoDebugHosts <value>` (default: `true`)
Whether to allow starting the archiver without debug/trace method support on Ethereum hosts
*Environment: `$ETHEREUM_ALLOW_NO_DEBUG_HOSTS`*

**SEQUENCER**

- `--sequencer`
Expand Down Expand Up @@ -1637,6 +1655,9 @@ Options:
- `--sequencer.injectFakeAttestation <value>`
Inject a fake attestation (for testing only)

- `--sequencer.shuffleAttestationOrdering <value>`
Shuffle attestation ordering to create invalid ordering (for testing only)

- `--sequencer.txPublicSetupAllowList <value>`
The list of functions calls allowed to run in setup
*Environment: `$TX_PUBLIC_SETUP_ALLOWLIST`*
Expand All @@ -1657,6 +1678,10 @@ Options:
True to use publishers in invalid states (timed out, cancelled, etc) if no other is available
*Environment: `$SEQ_PUBLISHER_ALLOW_INVALID_STATES`*

- `--sequencer.publisherForwarderAddress <value>`
Address of the forwarder contract to wrap all L1 transactions through (for testing purposes only)
*Environment: `$SEQ_PUBLISHER_FORWARDER_ADDRESS`*

- `--sequencer.blobSinkUrl <value>`
The URL of the blob sink
*Environment: `$BLOB_SINK_URL`*
Expand Down Expand Up @@ -1743,6 +1768,10 @@ Options:
True to use publishers in invalid states (timed out, cancelled, etc) if no other is available
*Environment: `$PROVER_PUBLISHER_ALLOW_INVALID_STATES`*

- `--proverNode.publisherForwarderAddress <value>`
Address of the forwarder contract to wrap all L1 transactions through (for testing purposes only)
*Environment: `$PROVER_PUBLISHER_FORWARDER_ADDRESS`*

- `--proverNode.publisherPrivateKeys <value>`
The private keys to be used by the publisher.
*Environment: `$PROVER_PUBLISHER_PRIVATE_KEYS`*
Expand Down Expand Up @@ -2161,7 +2190,7 @@ Options:
A list of metric prefixes to publicly export
*Environment: `$PUBLIC_OTEL_INCLUDE_METRICS`*

- `--tel.publicMetricsOptOut <value>`
- `--tel.publicMetricsOptOut <value>` (default: `true`)
Whether to opt out of sharing optional telemetry
*Environment: `$PUBLIC_OTEL_OPT_OUT`*

Expand Down Expand Up @@ -2336,8 +2365,7 @@ Usage: aztec update [options] [projectPath]
Updates Nodejs and Noir dependencies

Arguments:
projectPath Path to the project directory (default:
"/Users/aztec/code/aztec-packages/docs")
projectPath Path to the project directory

Options:
--contract [paths...] Paths to contracts to update dependencies (default:
Expand Down
Loading
Loading