Skip to content

Commit 5f5e5d8

Browse files
author
AztecBot
committed
Merge branch 'next' into ad/chore/ci-release-pr-canary
2 parents c2595eb + 698c170 commit 5f5e5d8

File tree

1,939 files changed

+351582
-10939
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,939 files changed

+351582
-10939
lines changed

.github/workflows/nightly-docs-release.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,15 @@ jobs:
139139
chmod +x /tmp/bb-bin/bb
140140
echo "BB_PATH=/tmp/bb-bin" >> $GITHUB_ENV
141141
142+
- name: Build noir packages
143+
run: |
144+
# Initialize noir submodule (required for yarn-project portal dependencies)
145+
git submodule update --init --recursive noir/noir-repo
146+
# Build noir JS packages (creates noir/packages/ directory needed by yarn-project)
147+
cd noir
148+
./bootstrap.sh install_deps
149+
./bootstrap.sh build_packages
150+
142151
- name: Build aztec CLI
143152
working-directory: ./yarn-project
144153
run: |

.github/workflows/release-please.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,15 @@ jobs:
187187
./bootstrap.sh build_native
188188
echo "BB_PATH=$(pwd)/build/bin" >> $GITHUB_ENV
189189
190+
- name: Build noir packages
191+
run: |
192+
# Initialize noir submodule (required for yarn-project portal dependencies)
193+
git submodule update --init --recursive noir/noir-repo
194+
# Build noir JS packages (creates noir/packages/ directory needed by yarn-project)
195+
cd noir
196+
./bootstrap.sh install_deps
197+
./bootstrap.sh build_packages
198+
190199
- name: Build aztec CLI
191200
working-directory: ./yarn-project
192201
run: |
Lines changed: 225 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,233 @@
11
---
2-
title: bb CLI Reference
3-
description: Comprehensive auto-generated reference for the bb (Barretenberg) command-line interface with all commands and options.
4-
tags: [cli, reference, autogenerated]
2+
title: Barretenberg CLI Reference
3+
description: Comprehensive auto-generated reference for the Barretenberg CLI with all commands and options.
4+
tags: [cli, reference, autogenerated, barretenberg, proving]
5+
sidebar_position: 1000
56
---
67

7-
# bb CLI Reference
8+
# Barretenberg CLI Reference
89

9-
_This documentation is auto-generated from the `bb` CLI help output._
10+
*This documentation is auto-generated from the `bb` CLI help output.*
1011

11-
_Generated: Placeholder - regenerate with `./scripts/generate_bb_cli_docs.sh`_
1212

13-
_Command: `bb`_
13+
*Generated: Fri 30 Jan 2026 05:14:36 UTC*
1414

15-
## Overview
15+
*Command: `bb`*
1616

17-
`bb` is Barretenberg's command-line interface for proving and verifying circuits. Run `bb --help` for the full set of available commands and options.
17+
## Table of Contents
18+
19+
- [bb](#bb)
20+
- [bb check](#bb-check)
21+
- [bb gates](#bb-gates)
22+
- [bb msgpack](#bb-msgpack)
23+
- [bb msgpack curve_constants](#bb-msgpack-curve_constants)
24+
- [bb msgpack run](#bb-msgpack-run)
25+
- [bb msgpack schema](#bb-msgpack-schema)
26+
- [bb prove](#bb-prove)
27+
- [bb verify](#bb-verify)
28+
- [bb write_solidity_verifier](#bb-write_solidity_verifier)
29+
- [bb write_vk](#bb-write_vk)
30+
## bb
31+
32+
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
33+
34+
**Usage:**
35+
```bash
36+
bb [OPTIONS] [SUBCOMMAND]
37+
```
38+
39+
**Available Commands:**
40+
41+
- `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.
42+
- `gates` - Construct a circuit from the given bytecode (in particular, expand black box functions) and return the gate count information.
43+
- `prove` - Generate a proof.
44+
- `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.
45+
- `verify` - Verify a proof.
46+
- `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.
47+
- `msgpack` - Msgpack API interface.
48+
49+
**Options:**
50+
51+
- `-h,--help` - Print this help message and exit
52+
- `--version` - Print the version string.
53+
- `--help-extended` - Show all options including advanced and Aztec-specific commands.
54+
55+
### Subcommands
56+
57+
### bb check
58+
59+
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.
60+
61+
**Usage:**
62+
```bash
63+
bb check [OPTIONS]
64+
```
65+
66+
**Options:**
67+
68+
- `-h,--help` - Print this help message and exit
69+
- `--help-extended` - Show all options including advanced ones.
70+
- `-b,--bytecode_path` - Path to ACIR bytecode generated by Noir.
71+
- `-w,--witness_path` - Path to partial witness generated by Noir.
72+
73+
### bb gates
74+
75+
Construct a circuit from the given bytecode (in particular, expand black box functions) and return the gate count information.
76+
77+
**Usage:**
78+
```bash
79+
bb gates [OPTIONS]
80+
```
81+
82+
**Options:**
83+
84+
- `-h,--help` - Print this help message and exit
85+
- `--help-extended` - Show all options including advanced ones.
86+
- `-b,--bytecode_path` - Path to ACIR bytecode generated by Noir.
87+
- `--include_gates_per_opcode` - Include gates_per_opcode in the output of the gates command.
88+
- `-t,--verifier_target` - Target verification environment. Determines hash function and ZK settings.
89+
*Environment: `BB_VERIFIER_TARGET`*
90+
91+
### bb msgpack
92+
93+
Msgpack API interface.
94+
95+
**Usage:**
96+
```bash
97+
bb msgpack [OPTIONS] [SUBCOMMAND]
98+
```
99+
100+
**Available Commands:**
101+
102+
- `schema` - Output a msgpack schema encoded as JSON to stdout.
103+
- `curve_constants` - Output curve constants as msgpack to stdout.
104+
- `run` - Execute msgpack API commands from stdin or file.
105+
106+
**Options:**
107+
108+
- `-h,--help` - Print this help message and exit
109+
110+
#### Subcommands
111+
112+
#### bb msgpack curve_constants
113+
114+
Output curve constants as msgpack to stdout.
115+
116+
**Usage:**
117+
```bash
118+
bb msgpack curve_constants [OPTIONS]
119+
```
120+
121+
**Options:**
122+
123+
- `-h,--help` - Print this help message and exit
124+
125+
#### bb msgpack run
126+
127+
Execute msgpack API commands from stdin or file.
128+
129+
**Usage:**
130+
```bash
131+
bb msgpack run [OPTIONS]
132+
```
133+
134+
**Options:**
135+
136+
- `-h,--help` - Print this help message and exit
137+
- `-i,--input` - Input file containing msgpack buffers (defaults to stdin)
138+
- `--request-ring-size` - Request ring buffer size for shared memory IPC (default: 1MB)
139+
- `--response-ring-size` - Response ring buffer size for shared memory IPC (default: 1MB)
140+
- `--max-clients` - Maximum concurrent clients for socket IPC servers (default: 1, only used for .sock files)
141+
142+
#### bb msgpack schema
143+
144+
Output a msgpack schema encoded as JSON to stdout.
145+
146+
**Usage:**
147+
```bash
148+
bb msgpack schema [OPTIONS]
149+
```
150+
151+
**Options:**
152+
153+
- `-h,--help` - Print this help message and exit
154+
155+
### bb prove
156+
157+
Generate a proof.
158+
159+
**Usage:**
160+
```bash
161+
bb prove [OPTIONS]
162+
```
163+
164+
**Options:**
165+
166+
- `-h,--help` - Print this help message and exit
167+
- `--help-extended` - Show all options including advanced ones.
168+
- `-b,--bytecode_path` - Path to ACIR bytecode generated by Noir.
169+
- `-w,--witness_path` - Path to partial witness generated by Noir.
170+
- `-o,--output_path` - Directory to write files or path of file to write, depending on subcommand.
171+
- `-k,--vk_path` - Path to a verification key.
172+
- `-t,--verifier_target` - Target verification environment. Determines hash function and ZK settings.
173+
*Environment: `BB_VERIFIER_TARGET`*
174+
- `--write_vk` - Write the provided circuit's verification key
175+
- `--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\}
176+
- `--verify` - Verify the proof natively, resulting in a boolean output. Useful for testing.
177+
178+
### bb verify
179+
180+
Verify a proof.
181+
182+
**Usage:**
183+
```bash
184+
bb verify [OPTIONS]
185+
```
186+
187+
**Options:**
188+
189+
- `-h,--help` - Print this help message and exit
190+
- `--help-extended` - Show all options including advanced ones.
191+
- `-i,--public_inputs_path` - Path to public inputs.
192+
- `-p,--proof_path` - Path to a proof.
193+
- `-k,--vk_path` - Path to a verification key.
194+
- `-t,--verifier_target` - Target verification environment. Determines hash function and ZK settings.
195+
*Environment: `BB_VERIFIER_TARGET`*
196+
197+
### bb write_solidity_verifier
198+
199+
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.
200+
201+
**Usage:**
202+
```bash
203+
bb write_solidity_verifier [OPTIONS]
204+
```
205+
206+
**Options:**
207+
208+
- `-h,--help` - Print this help message and exit
209+
- `--help-extended` - Show all options including advanced ones.
210+
- `-k,--vk_path` - Path to a verification key.
211+
- `-o,--output_path` - Directory to write files or path of file to write, depending on subcommand.
212+
- `-t,--verifier_target` - Target verification environment. Determines hash function and ZK settings.
213+
*Environment: `BB_VERIFIER_TARGET`*
214+
- `--optimized` - Use the optimized Solidity verifier.
215+
216+
### bb write_vk
217+
218+
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.
219+
220+
**Usage:**
221+
```bash
222+
bb write_vk [OPTIONS]
223+
```
224+
225+
**Options:**
226+
227+
- `-h,--help` - Print this help message and exit
228+
- `--help-extended` - Show all options including advanced ones.
229+
- `-b,--bytecode_path` - Path to ACIR bytecode generated by Noir.
230+
- `-o,--output_path` - Directory to write files or path of file to write, depending on subcommand.
231+
- `-t,--verifier_target` - Target verification environment. Determines hash function and ZK settings.
232+
*Environment: `BB_VERIFIER_TARGET`*
233+
- `--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\}

barretenberg/docs/versioned_docs/version-v4.0.0-nightly.20260126/bb-cli-reference.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)