Merge branch 'next' into merge-train/barretenberg

Author: AztecBot

barretenberg/docs/docs/bb-cli-reference.md

@@ -1,17 +1,233 @@
 ---
-title: bb CLI Reference
-description: Comprehensive auto-generated reference for the bb (Barretenberg) command-line interface with all commands and options.
-tags: [cli, reference, autogenerated]
+title: Barretenberg CLI Reference
+description: Comprehensive auto-generated reference for the Barretenberg CLI with all commands and options.
+tags: [cli, reference, autogenerated, barretenberg, proving]
+sidebar_position: 1000
 ---
 
-# bb CLI Reference
+# Barretenberg CLI Reference
 
-_This documentation is auto-generated from the `bb` CLI help output._
+*This documentation is auto-generated from the `bb` CLI help output.*
 
-_Generated: Placeholder - regenerate with `./scripts/generate_bb_cli_docs.sh`_
 
-_Command: `bb`_
+*Generated: Fri 30 Jan 2026 05:14:36 UTC*
 
-## Overview
+*Command: `bb`*
 
-`bb` is Barretenberg's command-line interface for proving and verifying circuits. Run `bb --help` for the full set of available commands and options.
+## Table of Contents
+
+- [bb](#bb)
+  - [bb check](#bb-check)
+  - [bb gates](#bb-gates)
+  - [bb msgpack](#bb-msgpack)
+    - [bb msgpack curve_constants](#bb-msgpack-curve_constants)
+    - [bb msgpack run](#bb-msgpack-run)
+    - [bb msgpack schema](#bb-msgpack-schema)
+  - [bb prove](#bb-prove)
+  - [bb verify](#bb-verify)
+  - [bb write_solidity_verifier](#bb-write_solidity_verifier)
+  - [bb write_vk](#bb-write_vk)
+## bb
+
+Barretenberg Your favo(u)rite zkSNARK library written in C++, a perfectly good computer programming language. Aztec Virtual Machine (AVM): disabled AVM Transpiler: enabled Starknet Garaga Extensions: disabled
+
+**Usage:**
+```bash
+bb [OPTIONS] [SUBCOMMAND]
+```
+
+**Available Commands:**
+
+- `check` - A debugging tool to quickly check whether a witness satisfies a circuit The function constructs the execution trace and iterates through it row by row, applying the polynomial relations defining the gate types. For Chonk, we check the VKs in the folding stack.
+- `gates` - Construct a circuit from the given bytecode (in particular, expand black box functions) and return the gate count information.
+- `prove` - Generate a proof.
+- `write_vk` - Write the verification key of a circuit. The circuit is constructed using quickly generated but invalid witnesses (which must be supplied in Barretenberg in order to expand ACIR black box opcodes), and no proof is constructed.
+- `verify` - Verify a proof.
+- `write_solidity_verifier` - Write a Solidity smart contract suitable for verifying proofs of circuit satisfiability for the circuit with verification key at vk_path. Not all hash types are implemented due to efficiency concerns.
+- `msgpack` - Msgpack API interface.
+
+**Options:**
+
+- `-h,--help` - Print this help message and exit
+- `--version` - Print the version string.
+- `--help-extended` - Show all options including advanced and Aztec-specific commands.
+
+### Subcommands
+
+### bb check
+
+A debugging tool to quickly check whether a witness satisfies a circuit The function constructs the execution trace and iterates through it row by row, applying the polynomial relations defining the gate types. For Chonk, we check the VKs in the folding stack.
+
+**Usage:**
+```bash
+bb check [OPTIONS]
+```
+
+**Options:**
+
+- `-h,--help` - Print this help message and exit
+- `--help-extended` - Show all options including advanced ones.
+- `-b,--bytecode_path` - Path to ACIR bytecode generated by Noir.
+- `-w,--witness_path` - Path to partial witness generated by Noir.
+
+### bb gates
+
+Construct a circuit from the given bytecode (in particular, expand black box functions) and return the gate count information.
+
+**Usage:**
+```bash
+bb gates [OPTIONS]
+```
+
+**Options:**
+
+- `-h,--help` - Print this help message and exit
+- `--help-extended` - Show all options including advanced ones.
+- `-b,--bytecode_path` - Path to ACIR bytecode generated by Noir.
+- `--include_gates_per_opcode` - Include gates_per_opcode in the output of the gates command.
+- `-t,--verifier_target` - Target verification environment. Determines hash function and ZK settings.
+  *Environment: `BB_VERIFIER_TARGET`*
+
+### bb msgpack
+
+Msgpack API interface.
+
+**Usage:**
+```bash
+bb msgpack [OPTIONS] [SUBCOMMAND]
+```
+
+**Available Commands:**
+
+- `schema` - Output a msgpack schema encoded as JSON to stdout.
+- `curve_constants` - Output curve constants as msgpack to stdout.
+- `run` - Execute msgpack API commands from stdin or file.
+
+**Options:**
+
+- `-h,--help` - Print this help message and exit
+
+#### Subcommands
+
+#### bb msgpack curve_constants
+
+Output curve constants as msgpack to stdout.
+
+**Usage:**
+```bash
+bb msgpack curve_constants [OPTIONS]
+```
+
+**Options:**
+
+- `-h,--help` - Print this help message and exit
+
+#### bb msgpack run
+
+Execute msgpack API commands from stdin or file.
+
+**Usage:**
+```bash
+bb msgpack run [OPTIONS]
+```
+
+**Options:**
+
+- `-h,--help` - Print this help message and exit
+- `-i,--input` - Input file containing msgpack buffers (defaults to stdin)
+- `--request-ring-size` - Request ring buffer size for shared memory IPC (default: 1MB)
+- `--response-ring-size` - Response ring buffer size for shared memory IPC (default: 1MB)
+- `--max-clients` - Maximum concurrent clients for socket IPC servers (default: 1, only used for .sock files)
+
+#### bb msgpack schema
+
+Output a msgpack schema encoded as JSON to stdout.
+
+**Usage:**
+```bash
+bb msgpack schema [OPTIONS]
+```
+
+**Options:**
+
+- `-h,--help` - Print this help message and exit
+
+### bb prove
+
+Generate a proof.
+
+**Usage:**
+```bash
+bb prove [OPTIONS]
+```
+
+**Options:**
+
+- `-h,--help` - Print this help message and exit
+- `--help-extended` - Show all options including advanced ones.
+- `-b,--bytecode_path` - Path to ACIR bytecode generated by Noir.
+- `-w,--witness_path` - Path to partial witness generated by Noir.
+- `-o,--output_path` - Directory to write files or path of file to write, depending on subcommand.
+- `-k,--vk_path` - Path to a verification key.
+- `-t,--verifier_target` - Target verification environment. Determines hash function and ZK settings.
+  *Environment: `BB_VERIFIER_TARGET`*
+- `--write_vk` - Write the provided circuit's verification key
+- `--output_format` - Output format for proofs and verification keys: 'binary' (default) or 'json'. JSON format includes metadata like bb_version, scheme, and verifier_target. Options: \{binary, json\}
+- `--verify` - Verify the proof natively, resulting in a boolean output. Useful for testing.
+
+### bb verify
+
+Verify a proof.
+
+**Usage:**
+```bash
+bb verify [OPTIONS]
+```
+
+**Options:**
+
+- `-h,--help` - Print this help message and exit
+- `--help-extended` - Show all options including advanced ones.
+- `-i,--public_inputs_path` - Path to public inputs.
+- `-p,--proof_path` - Path to a proof.
+- `-k,--vk_path` - Path to a verification key.
+- `-t,--verifier_target` - Target verification environment. Determines hash function and ZK settings.
+  *Environment: `BB_VERIFIER_TARGET`*
+
+### bb write_solidity_verifier
+
+Write a Solidity smart contract suitable for verifying proofs of circuit satisfiability for the circuit with verification key at vk_path. Not all hash types are implemented due to efficiency concerns.
+
+**Usage:**
+```bash
+bb write_solidity_verifier [OPTIONS]
+```
+
+**Options:**
+
+- `-h,--help` - Print this help message and exit
+- `--help-extended` - Show all options including advanced ones.
+- `-k,--vk_path` - Path to a verification key.
+- `-o,--output_path` - Directory to write files or path of file to write, depending on subcommand.
+- `-t,--verifier_target` - Target verification environment. Determines hash function and ZK settings.
+  *Environment: `BB_VERIFIER_TARGET`*
+- `--optimized` - Use the optimized Solidity verifier.
+
+### bb write_vk
+
+Write the verification key of a circuit. The circuit is constructed using quickly generated but invalid witnesses (which must be supplied in Barretenberg in order to expand ACIR black box opcodes), and no proof is constructed.
+
+**Usage:**
+```bash
+bb write_vk [OPTIONS]
+```
+
+**Options:**
+
+- `-h,--help` - Print this help message and exit
+- `--help-extended` - Show all options including advanced ones.
+- `-b,--bytecode_path` - Path to ACIR bytecode generated by Noir.
+- `-o,--output_path` - Directory to write files or path of file to write, depending on subcommand.
+- `-t,--verifier_target` - Target verification environment. Determines hash function and ZK settings.
+  *Environment: `BB_VERIFIER_TARGET`*
+- `--output_format` - Output format for proofs and verification keys: 'binary' (default) or 'json'. JSON format includes metadata like bb_version, scheme, and verifier_target. Options: \{binary, json\}