1"use strict";(globalThis.webpackChunkdocs=globalThis.webpackChunkdocs||[]).push([[25],{50235(e,n,s){s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>c,metadata:()=>r,toc:()=>a});const r=JSON.parse('{"id":"reference/nargo_commands","title":"Nargo","description":"Noir CLI Commands for Noir Prover and Verifier to create, execute, prove and verify programs, generate Solidity verifier smart contract and compile into JSON file containing ACIR representation and ABI of circuit.","source":"@site/versioned_docs/version-v1.0.0-beta.26/reference/nargo_commands.md","sourceDirName":"reference","slug":"/reference/nargo_commands","permalink":"/docs/v1.0.0-beta.26/reference/nargo_commands","draft":false,"unlisted":false,"editUrl":"https://github.com/noir-lang/noir/edit/master/docs/versioned_docs/version-v1.0.0-beta.26/reference/nargo_commands.md","tags":[],"version":"v1.0.0-beta.26","sidebarPosition":0,"frontMatter":{"title":"Nargo","description":"Noir CLI Commands for Noir Prover and Verifier to create, execute, prove and verify programs, generate Solidity verifier smart contract and compile into JSON file containing ACIR representation and ABI of circuit.","keywords":["Nargo","Noir CLI","Noir Prover","Noir Verifier","generate Solidity verifier","compile JSON file","ACIR representation","ABI of circuit","TypeScript"],"sidebar_position":0},"sidebar":"sidebar","previous":{"title":"Building a web app with Noir and Barretenberg","permalink":"/docs/v1.0.0-beta.26/guides/building_a_web_app"},"next":{"title":"noir_js","permalink":"/docs/v1.0.0-beta.26/reference/NoirJS/noir_js/"}}');var i=s(74848),l=s(28453);const c={title:"Nargo",description:"Noir CLI Commands for Noir Prover and Verifier to create, execute, prove and verify programs, generate Solidity verifier smart contract and compile into JSON file containing ACIR representation and ABI of circuit.",keywords:["Nargo","Noir CLI","Noir Prover","Noir Verifier","generate Solidity verifier","compile JSON file","ACIR representation","ABI of circuit","TypeScript"],sidebar_position:0},d="Command-Line Help for nargo",o={},a=[{value:"<code>nargo</code>",id:"nargo",level:2},{value:"<strong>Subcommands:</strong>",id:"subcommands",level:6},{value:"<strong>Options:</strong>",id:"options",level:6},{value:"<code>nargo check</code>",id:"nargo-check",level:2},{value:"<strong>Options:</strong>",id:"options-1",level:6},{value:"<code>nargo fmt</code>",id:"nargo-fmt",level:2},{value:"<strong>Options:</strong>",id:"options-2",level:6},{value:"<code>nargo compile</code>",id:"nargo-compile",level:2},{value:"<strong>Options:</strong>",id:"options-3",level:6},{value:"<code>nargo new</code>",id:"nargo-new",level:2},{value:"<strong>Arguments:</strong>",id:"arguments",level:6},{value:"<strong>Options:</strong>",id:"options-4",level:6},{value:"<code>nargo init</code>",id:"nargo-init",level:2},{value:"<strong>Options:</strong>",id:"options-5",level:6},{value:"<code>nargo add</code>",id:"nargo-add",level:2},{value:"<strong>Arguments:</strong>",id:"arguments-1",level:6},{value:"<strong>Options:</strong>",id:"options-6",level:6},{value:"<code>nargo fetch</code>",id:"nargo-fetch",level:2},{value:"<strong>Options:</strong>",id:"options-7",level:6},{value:"<code>nargo execute</code>",id:"nargo-execute",level:2},{value:"<strong>Arguments:</strong>",id:"arguments-2",level:6},{value:"<strong>Options:</strong>",id:"options-8",level:6},{value:"<code>nargo export</code>",id:"nargo-export",level:2},{value:"<strong>Options:</strong>",id:"options-9",level:6},{value:"<code>nargo debug</code>",id:"nargo-debug",level:2},{value:"<strong>Arguments:</strong>",id:"arguments-3",level:6},{value:"<strong>Options:</strong>",id:"options-10",level:6},{value:"<code>nargo test</code>",id:"nargo-test",level:2},{value:"<strong>Arguments:</strong>",id:"arguments-4",level:6},{value:"<strong>Options:</strong>",id:"options-11",level:6},{value:"<code>nargo fuzz</code>
1",id:"nargo-fuzz",level:2},{value:"<strong>Arguments:</strong>",id:"arguments-5",level:6},{value:"<strong>Options:</strong>",id:"options-12",level:6},{value:"<code>nargo info</code>",id:"nargo-info",level:2},{value:"<strong>Options:</strong>",id:"options-13",level:6},{value:"<code>nargo lsp</code>",id:"nargo-lsp",level:2},{value:"<code>nargo expand</code>",id:"nargo-expand",level:2},{value:"<strong>Options:</strong>",id:"options-14",level:6},{value:"<code>nargo doc</code>",id:"nargo-doc",level:2},{value:"<strong>Options:</strong>",id:"options-15",level:6},{value:"<code>nargo generate-completion-script</code>",id:"nargo-generate-completion-script",level:2},{value:"<strong>Arguments:</strong>",id:"arguments-6",level:6}];function t(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h6:"h6",header:"header",hr:"hr",i:"i",li:"li",p:"p",small:"small",strong:"strong",ul:"ul",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsxs)(n.h1,{id:"command-line-help-for-nargo",children:["Command-Line Help for ",(0,i.jsx)(n.code,{children:"nargo"})]})}),"\n",(0,i.jsxs)(n.p,{children:["This document contains the help content for the ",(0,i.jsx)(n.code,{children:"nargo"})," command-line program."]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"Command Overview:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsxs)(n.a,{href:"#nargo",children:[(0,i.jsx)(n.code,{children:"nargo"}),"\u21b4"]})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsxs)(n.a,{href:"#nargo-check",children:[(0,i.jsx)(n.code,{children:"nargo check"}),"\u21b4"]})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsxs)(n.a,{href:"#nargo-fmt",children:[(0,i.jsx)(n.code,{children:"nargo fmt"}),"\u21b4"]})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsxs)(n.a,{href:"#nargo-compile",children:[(0,i.jsx)(n.code,{children:"nargo compile"}),"\u21b4"]})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsxs)(n.a,{href:"#nargo-new",children:[(0,i.jsx)(n.code,{children:"nargo new"}),"\u21b4"]})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsxs)(n.a,{href:"#nargo-init",children:[(0,i.jsx)(n.code,{children:"nargo init"}),"\u21b4"]})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsxs)(n.a,{href:"#nargo-add",children:[(0,i.jsx)(n.code,{children:"nargo add"}),"\u21b4"]})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsxs)(n.a,{href:"#nargo-fetch",children:[(0,i.jsx)(n.code,{children:"nargo fetch"}),"\u21b4"]})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsxs)(n.a,{href:"#nargo-execute",children:[(0,i.jsx)(n.code,{children:"nargo execute"}),"\u21b4"]})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsxs)(n.a,{href:"#nargo-export",children:[(0,i.jsx)(n.code,{children:"nargo export"}),"\u21b4"]})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsxs)(n.a,{href:"#nargo-debug",children:[(0,i.jsx)(n.code,{children:"nargo debug"}),"\u21b4"]})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsxs)(n.a,{href:"#nargo-test",children:[(0,i.jsx)(n.code,{children:"nargo test"}),"\u21b4"]})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsxs)(n.a,{href:"#nargo-fuzz",children:[(0,i.jsx)(n.code,{children:"nargo fuzz"}),"\u21b4"]})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsxs)(n.a,{href:"#nargo-info",children:[(0,i.jsx)(n.code,{children:"nargo info"}),"\u21b4"]})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsxs)(n.a,{href:"#nargo-lsp",children:[(0,i.jsx)(n.code,{children:"nargo lsp"}),"\u21b4"]})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsxs)(n.a,{href:"#nargo-expand",children:[(0,i.jsx)(n.code,{children:"nargo expand"}),"\u21b4"]})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsxs)(n.a,{href:"#nargo-doc",children:[(0,i.jsx)(n.code,{children:"nargo doc"}),"\u21b4"]})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsxs)(n.a,{href:"#nargo-generate-completion-script",children:[(0,i.jsx)(n.code,{children:"nargo generate-completion-script"}),"\u21b4"]})}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"nargo",children:(0,i.jsx)(n.code,{children:"nargo"})}),"\n",(0,i.jsx)(n.p,{children:"Noir's package manager"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Usage:"})," ",(0,i.jsx)(n.code,{children:"nargo <COMMAND>"})]}),"\n",(0,i.jsx)(n.h6,{id:"subcommands",children:(0,i.jsx)(n.strong,{children:"Subcommands:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"check"})," \u2014 Check a local package and all of its dependencies for errors"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"fmt"})," \u2014 Format the Noir files in a workspace"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"compile"})," \u2014 Compile the program and its secret execution trace into ACIR format"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"new"})," \u2014 Create a Noir project in a new directory"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"init"})," \u2014 Create a Noir project in the current directory"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"add"})," \u2014 Add a dependency to the package's ",(0,i.jsx)(n.code,{children:"Nargo.toml"})]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"fetch"})," \u2014 Fetch the dependencies of a package from the network"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"execute"})," \u2014 Executes a circuit to calculate its return value"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"export"})," \u2014 Exports functions marked with #[export] attribute"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"debug"})," \u2014 Executes a circuit in debug mode"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"test"})," \u2014 Run the tests for this program"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"fuzz"})," \u2014 Run the fuzzing harnesses for this program"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"info"})," \u2014 Provides detailed information on each of a program's function (represented by a single circuit)"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"lsp"})," \u2014 Starts the Noir LSP server"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"expand"})," \u2014 Show the result of macro expansion"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"doc"})," \u2014 Builds documentation for the specified package or workspace"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"generate-completion-script"})," \u2014 Generates a shell completion script for your favorite shell"]}),"\n"]}),"\n",(0,i.jsx)(n.h6,{id:"options",children:(0,i.jsx)(n.strong,{children:"Options:"})}),"\n",(0,i.jsx)(n.h2,{id:"nargo-check",children:(0,i.jsx)(n.code,{children:"nargo check"})}),"\n",(0,i.jsx)(n.p,{children:"Check a local package and all of its dependencies for errors"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Usage:"})," ",(0,i.jsx)(n.code,{children:"nargo check [OPTIONS]"})]}),"\n",(0,i.jsx)(n.h6,{id:"options-1",children:(0,i.jsx)(n.strong,{children:"Options:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--package <PACKAGE>"})," \u2014 The name of the package to run the command on. By default run on the first one found moving up along the ancestors of the current directory"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--workspace"})," \u2014 Run on all packages in the workspace"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--overwrite"})," \u2014 Force overwrite of existing files"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--force"})," \u2014 Force a full recompilation"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--print-acir"})," \u2014 Display the ACIR for compiled circuit, including the Brillig bytecode"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--deny-warnings"})," \u2014 Treat all warnings as errors"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--silence-warnings"})," \u2014 Suppress warnings"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--debug-comptime-in-file <DEBUG_COMPTIME_IN_FILE>"}),' \u2014 Enable printing results of comptime evaluation: provide a path suffix for the module to debug, e.g. "',(0,i.jsx)(n.code,{children:"package_name/src/main.nr"}),'"']}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-underconstrained-check"})," \u2014 Flag to turn off the compiler check for under constrained values. Warning: This can improve c
1ompilation speed but can also lead to correctness errors. This check should always be run on production code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-brillig-constraints-check"})," \u2014 Flag to turn off the compiler check for missing Brillig call constraints. Warning: This can improve compilation speed but can also lead to correctness errors. This check should always be run on production code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--inliner-aggressiveness <INLINER_AGGRESSIVENESS>"})," \u2014 Setting to decide on an inlining strategy for Brillig functions. A more aggressive inliner should generate larger programs but more optimized A less aggressive inliner should generate smaller programs"]}),"\n",(0,i.jsxs)(n.p,{children:["Default value: ",(0,i.jsx)(n.code,{children:"9223372036854775807"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"-Z"}),", ",(0,i.jsx)(n.code,{children:"--unstable-features <UNSTABLE_FEATURES>"})," \u2014 Unstable features to enable for this current build."]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If non-empty, it disables unstable features required in crate manifests."}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--no-unstable-features"})," \u2014 Disable any unstable features required in crate manifests"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"nargo-fmt",children:(0,i.jsx)(n.code,{children:"nargo fmt"})}),"\n",(0,i.jsx)(n.p,{children:"Format the Noir files in a workspace"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Usage:"})," ",(0,i.jsx)(n.code,{children:"nargo fmt [OPTIONS]"})]}),"\n",(0,i.jsx)(n.h6,{id:"options-2",children:(0,i.jsx)(n.strong,{children:"Options:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--check"})," \u2014 Run noirfmt in check mode"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--package <PACKAGE>"})," \u2014 The name of the package to run the command on. By default run on the first one found moving up along the ancestors of the current directory"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--workspace"})," \u2014 Run on all packages in the workspace"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"nargo-compile",children:(0,i.jsx)(n.code,{children:"nargo compile"})}),"\n",(0,i.jsx)(n.p,{children:"Compile the program and its secret execution trace into ACIR format"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Usage:"})," ",(0,i.jsx)(n.code,{children:"nargo compile [OPTIONS]"})]}),"\n",(0,i.jsx)(n.h6,{id:"options-3",children:(0,i.jsx)(n.strong,{children:"Options:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--package <PACKAGE>"})," \u2014 The name of the package to run the command on. By default run on the first one found moving up along the ancestors of the current directory"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--workspace"})," \u2014 Run on all packages in the workspace"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--force"})," \u2014 Force a full recompilation"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--print-acir"})," \u2014 Display the ACIR for compiled circuit, including the Brillig bytecode"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--deny-warnings"})," \u2014 Treat all warnings as errors"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--silence-warnings"})," \u2014 Suppress warnings"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--debug-comptime-in-file <DEBUG_COMPTIME_IN_FILE>"}),' \u2014 Enable printing results of comptime evaluation: provide a path suffix for the module to debug, e.g. "',(0,i.jsx)(n.code,{children:"package_name/src/main.nr"}),'"']}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-underconstrained-check"})," \u2014 Flag to turn off the compiler check for under constrained values. Warning: This can improve c
1ompilation speed but can also lead to correctness errors. This check should always be run on production code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-brillig-constraints-check"})," \u2014 Flag to turn off the compiler check for missing Brillig call constraints. Warning: This can improve compilation speed but can also lead to correctness errors. This check should always be run on production code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--inliner-aggressiveness <INLINER_AGGRESSIVENESS>"})," \u2014 Setting to decide on an inlining strategy for Brillig functions. A more aggressive inliner should generate larger programs but more optimized A less aggressive inliner should generate smaller programs"]}),"\n",(0,i.jsxs)(n.p,{children:["Default value: ",(0,i.jsx)(n.code,{children:"9223372036854775807"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"-Z"}),", ",(0,i.jsx)(n.code,{children:"--unstable-features <UNSTABLE_FEATURES>"})," \u2014 Unstable features to enable for this current build."]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If non-empty, it disables unstable features required in crate manifests."}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--no-unstable-features"})," \u2014 Disable any unstable features required in crate manifests"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"nargo-new",children:(0,i.jsx)(n.code,{children:"nargo new"})}),"\n",(0,i.jsx)(n.p,{children:"Create a Noir project in a new directory"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Usage:"})," ",(0,i.jsx)(n.code,{children:"nargo new [OPTIONS] <PATH>"})]}),"\n",(0,i.jsx)(n.h6,{id:"arguments",children:(0,i.jsx)(n.strong,{children:"Arguments:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"<PATH>"})," \u2014 The path to save the new project"]}),"\n"]}),"\n",(0,i.jsx)(n.h6,{id:"options-4",children:(0,i.jsx)(n.strong,{children:"Options:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--name <NAME>"})," \u2014 Name of the package [default: package directory name]"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--lib"})," \u2014 Use a library template"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--bin"})," \u2014 Use a binary template [default]"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--contract"})," \u2014 Use a contract template"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"nargo-init",children:(0,i.jsx)(n.code,{children:"nargo init"})}),"\n",(0,i.jsx)(n.p,{children:"Create a Noir project in the current directory"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Usage:"})," ",(0,i.jsx)(n.code,{children:"nargo init [OPTIONS]"})]}),"\n",(0,i.jsx)(n.h6,{id:"options-5",children:(0,i.jsx)(n.strong,{children:"Options:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--name <NAME>"})," \u2014 Name of the package [default: current directory name]"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--lib"})," \u2014 Use a library template"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--bin"})," \u2014 Use a binary template [default]"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--contract"})," \u2014 Use a contract template"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"nargo-add",children:(0,i.jsx)(n.code,{children:"nargo add"})}),"\n",(0,i.jsxs)(n.p,{children:["Add a dependency to the package's ",(0,i.jsx)(n.code,{children:"Nargo.toml"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["The dependency is resolved (and, for git dependencies, downloaded) before the manifest is
1written, so a dependency that cannot be found never ends up in ",(0,i.jsx)(n.code,{children:"Nargo.toml"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Usage:"})," ",(0,i.jsx)(n.code,{children:"nargo add [OPTIONS] <--path <PATH>|--git <GIT>> [NAME]"})]}),"\n",(0,i.jsx)(n.h6,{id:"arguments-1",children:(0,i.jsx)(n.strong,{children:"Arguments:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"<NAME>"})," \u2014 Name to use for the dependency (the key under ",(0,i.jsx)(n.code,{children:"[dependencies]"}),"). Defaults to the package name declared in the dependency's own ",(0,i.jsx)(n.code,{children:"Nargo.toml"})]}),"\n"]}),"\n",(0,i.jsx)(n.h6,{id:"options-6",children:(0,i.jsx)(n.strong,{children:"Options:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--path <PATH>"})," \u2014 Path to a local dependency, relative to this package's ",(0,i.jsx)(n.code,{children:"Nargo.toml"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--git <GIT>"})," \u2014 URL of a git repository to depend on"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--tag <TAG>"})," \u2014 Git branch or tag to use (required with ",(0,i.jsx)(n.code,{children:"--git"}),")"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--directory <DIRECTORY>"})," \u2014 Subdirectory within the git repository that contains the package"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--override"})," \u2014 Replace the dependency if one with the same name already exists"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--package <PACKAGE>"})," \u2014 The name of the package to run the command on. By default run on the first one found moving up along the ancestors of the current directory"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--workspace"})," \u2014 Run on all packages in the workspace"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"nargo-fetch",children:(0,i.jsx)(n.code,{children:"nargo fetch"})}),"\n",(0,i.jsx)(n.p,{children:"Fetch the dependencies of a package from the network"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Usage:"})," ",(0,i.jsx)(n.code,{children:"nargo fetch [OPTIONS]"})]}),"\n",(0,i.jsx)(n.h6,{id:"options-7",children:(0,i.jsx)(n.strong,{children:"Options:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--package <PACKAGE>"})," \u2014 The name of the package to run the command on. By default run on the first one found moving up along the ancestors of the current directory"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--workspace"})," \u2014 Run on all packages in the workspace"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"nargo-execute",children:(0,i.jsx)(n.code,{children:"nargo execute"})}),"\n",(0,i.jsx)(n.p,{children:"Executes a circuit to calculate its return value"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Usage:"})," ",(0,i.jsx)(n.code,{children:"nargo execute [OPTIONS] [WITNESS_NAME]"})]}),"\n",(0,i.jsx)(n.h6,{id:"arguments-2",children:(0,i.jsx)(n.strong,{children:"Arguments:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"<WITNESS_NAME>"})," \u2014 Write the execution witness to named file"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Defaults to the name of the package being executed."}),"\n",(0,i.jsx)(n.h6,{id:"options-8",children:(0,i.jsx)(n.strong,{children:"Options:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"-p"}),", ",(0,i.jsx)(n.code,{children:"--prover-name <PROVER_NAME>"})," \u2014 The name of the toml file which contains the inputs for the prover"]}),"\n",(0,i.jsxs)(n.p,{children:["Default value: ",(0,i.jsx)(n.code,{children:"Prover"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--overwrite-return"})," \u2014 Optionally overwrite the ",(0,i.jsx)(n.code,{children:"return"})," entry in the prover file"]}),"\n",(0,i.jsxs)(n.p,{children:["Default value: ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--package <PACKAGE>"})," \u2014 The name of the package to run the command on. By default run on the first one found moving up along the ancestors of the current directory"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--workspace"})," \u2014 Run on all packages in the workspace"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--force"})," \u2014 Force a full recompilation"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--print-acir"})," \u2014 Display the ACIR for compiled circuit, including the Brillig bytecode"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--deny-warnings"})," \u2014 Treat all warnings as errors"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--silence-warnings"})," \u2014 Suppress warnings"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--debug-comptime-in-file <DEBUG_COMPTIME_IN_FILE>"}),' \u2014 Enable printing results of comptime evaluation: provide a path suffix for the module to debug, e.g. "',(0,i.jsx)(n.code,{children:"package_name/src/main.nr"}),'"']}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-underconstrained-check"})," \u2014 Flag to turn off the compiler check for under constrained values. Warning: This can improve c
1ompilation speed but can also lead to correctness errors. This check should always be run on production code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-brillig-constraints-check"})," \u2014 Flag to turn off the compiler check for missing Brillig call constraints. Warning: This can improve compilation speed but can also lead to correctness errors. This check should always be run on production code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--inliner-aggressiveness <INLINER_AGGRESSIVENESS>"})," \u2014 Setting to decide on an inlining strategy for Brillig functions. A more aggressive inliner should generate larger programs but more optimized A less aggressive inliner should generate smaller programs"]}),"\n",(0,i.jsxs)(n.p,{children:["Default value: ",(0,i.jsx)(n.code,{children:"9223372036854775807"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"-Z"}),", ",(0,i.jsx)(n.code,{children:"--unstable-features <UNSTABLE_FEATURES>"})," \u2014 Unstable features to enable for this current build."]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If non-empty, it disables unstable features required in crate manifests."}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--no-unstable-features"})," \u2014 Disable any unstable features required in crate manifests"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--oracle-resolver <ORACLE_RESOLVER>"})," \u2014 JSON RPC url to solve oracle calls"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--oracle-file <ORACLE_FILE>"})," \u2014 Path to the oracle transcript"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--count-array-copies"})," \u2014 Count the number of arrays that are copied in an unconstrained context for performance debugging"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"nargo-export",children:(0,i.jsx)(n.code,{children:"nargo export"})}),"\n",(0,i.jsx)(n.p,{children:"Exports functions marked with #[export] attribute"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Usage:"})," ",(0,i.jsx)(n.code,{children:"nargo export [OPTIONS]"})]}),"\n",(0,i.jsx)(n.h6,{id:"options-9",children:(0,i.jsx)(n.strong,{children:"Options:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--package <PACKAGE>"})," \u2014 The name of the package to run the command on. By default run on the first one found moving up along the ancestors of the current directory"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--workspace"})," \u2014 Run on all packages in the workspace"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--force"})," \u2014 Force a full recompilation"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--print-acir"})," \u2014 Display the ACIR for compiled circuit, including the Brillig bytecode"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--deny-warnings"})," \u2014 Treat all warnings as errors"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--silence-warnings"})," \u2014 Suppress warnings"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--debug-comptime-in-file <DEBUG_COMPTIME_IN_FILE>"}),' \u2014 Enable printing results of comptime evaluation: provide a path suffix for the module to debug, e.g. "',(0,i.jsx)(n.code,{children:"package_name/src/main.nr"}),'"']}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-underconstrained-check"})," \u2014 Flag to turn off the compiler check for under constrained values. Warning: This can improve c
1ompilation speed but can also lead to correctness errors. This check should always be run on production code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-brillig-constraints-check"})," \u2014 Flag to turn off the compiler check for missing Brillig call constraints. Warning: This can improve compilation speed but can also lead to correctness errors. This check should always be run on production code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--inliner-aggressiveness <INLINER_AGGRESSIVENESS>"})," \u2014 Setting to decide on an inlining strategy for Brillig functions. A more aggressive inliner should generate larger programs but more optimized A less aggressive inliner should generate smaller programs"]}),"\n",(0,i.jsxs)(n.p,{children:["Default value: ",(0,i.jsx)(n.code,{children:"9223372036854775807"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"-Z"}),", ",(0,i.jsx)(n.code,{children:"--unstable-features <UNSTABLE_FEATURES>"})," \u2014 Unstable features to enable for this current build."]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If non-empty, it disables unstable features required in crate manifests."}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--no-unstable-features"})," \u2014 Disable any unstable features required in crate manifests"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"nargo-debug",children:(0,i.jsx)(n.code,{children:"nargo debug"})}),"\n",(0,i.jsx)(n.p,{children:"Executes a circuit in debug mode"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Usage:"})," ",(0,i.jsx)(n.code,{children:"nargo debug [OPTIONS] [WITNESS_NAME]"})]}),"\n",(0,i.jsx)(n.h6,{id:"arguments-3",children:(0,i.jsx)(n.strong,{children:"Arguments:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"<WITNESS_NAME>"})," \u2014 Write the execution witness to named file"]}),"\n"]}),"\n",(0,i.jsx)(n.h6,{id:"options-10",children:(0,i.jsx)(n.strong,{children:"Options:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"-p"}),", ",(0,i.jsx)(n.code,{children:"--prover-name <PROVER_NAME>"})," \u2014 The name of the toml file which contains the inputs for the prover"]}),"\n",(0,i.jsxs)(n.p,{children:["Default value: ",(0,i.jsx)(n.code,{children:"Prover"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--package <PACKAGE>"})," \u2014 The name of the package to execute"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--force"})," \u2014 Force a full recompilation"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--print-acir"})," \u2014 Display the ACIR for compiled circuit, including the Brillig bytecode"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--deny-warnings"})," \u2014 Treat all warnings as errors"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--silence-warnings"})," \u2014 Suppress warnings"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--debug-comptime-in-file <DEBUG_COMPTIME_IN_FILE>"}),' \u2014 Enable printing results of comptime evaluation: provide a path suffix for the module to debug, e.g. "',(0,i.jsx)(n.code,{children:"package_name/src/main.nr"}),'"']}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-underconstrained-check"})," \u2014 Flag to turn off the compiler check for under constrained values. Warning: This can improve c
1ompilation speed but can also lead to correctness errors. This check should always be run on production code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-brillig-constraints-check"})," \u2014 Flag to turn off the compiler check for missing Brillig call constraints. Warning: This can improve compilation speed but can also lead to correctness errors. This check should always be run on production code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--inliner-aggressiveness <INLINER_AGGRESSIVENESS>"})," \u2014 Setting to decide on an inlining strategy for Brillig functions. A more aggressive inliner should generate larger programs but more optimized A less aggressive inliner should generate smaller programs"]}),"\n",(0,i.jsxs)(n.p,{children:["Default value: ",(0,i.jsx)(n.code,{children:"9223372036854775807"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"-Z"}),", ",(0,i.jsx)(n.code,{children:"--unstable-features <UNSTABLE_FEATURES>"})," \u2014 Unstable features to enable for this current build."]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If non-empty, it disables unstable features required in crate manifests."}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--no-unstable-features"})," \u2014 Disable any unstable features required in crate manifests"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--acir-mode"})," \u2014 Force ACIR output (disabling instrumentation)"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-instrumentation <SKIP_INSTRUMENTATION>"})," \u2014 Disable vars debug instrumentation (enabled by default)"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--test-name <TEST_NAME>"})," \u2014 Name (or substring) of the test function to debug"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--oracle-resolver <ORACLE_RESOLVER>"})," \u2014 JSON RPC url to solve oracle calls"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"nargo-test",children:(0,i.jsx)(n.code,{children:"nargo test"})}),"\n",(0,i.jsx)(n.p,{children:"Run the tests for this program"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Usage:"})," ",(0,i.jsx)(n.code,{children:"nargo test [OPTIONS] [TEST_NAMES]..."})]}),"\n",(0,i.jsx)(n.h6,{id:"arguments-4",children:(0,i.jsx)(n.strong,{children:"Arguments:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"<TEST_NAMES>"})," \u2014 If given, only tests with names containing this string will be run"]}),"\n"]}),"\n",(0,i.jsx)(n.h6,{id:"options-11",children:(0,i.jsx)(n.strong,{children:"Options:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--show-output"})," \u2014 Display output of ",(0,i.jsx)(n.code,{children:"println"})," statements"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--exact"})," \u2014 Only run tests that match exactly"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--list-tests"})," \u2014 Print all matching test names, without running them"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--no-run"})," \u2014 Only compile the tests, without running them"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--package <PACKAGE>"})," \u2014 The name of the package to run the command on. By default run on the first one found moving up along the ancestors of the current directory"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--workspace"})," \u2014 Run on all packages in the workspace"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--force"})," \u2014 Force a full recompilation"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--print-acir"})," \u2014 Display the ACIR for compiled circuit, including the Brillig bytecode"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--deny-warnings"})," \u2014 Treat all warnings as errors"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--silence-warnings"})," \u2014 Suppress warnings"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--debug-comptime-in-file <DEBUG_COMPTIME_IN_FILE>"}),' \u2014 Enable printing results of comptime evaluation: provide a path suffix for the module to debug, e.g. "',(0,i.jsx)(n.code,{children:"package_name/src/main.nr"}),'"']}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-underconstrained-check"})," \u2014 Flag to turn off the compiler check for under constrained values. Warning: This can improve c
1ompilation speed but can also lead to correctness errors. This check should always be run on production code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-brillig-constraints-check"})," \u2014 Flag to turn off the compiler check for missing Brillig call constraints. Warning: This can improve compilation speed but can also lead to correctness errors. This check should always be run on production code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--inliner-aggressiveness <INLINER_AGGRESSIVENESS>"})," \u2014 Setting to decide on an inlining strategy for Brillig functions. A more aggressive inliner should generate larger programs but more optimized A less aggressive inliner should generate smaller programs"]}),"\n",(0,i.jsxs)(n.p,{children:["Default value: ",(0,i.jsx)(n.code,{children:"9223372036854775807"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"-Z"}),", ",(0,i.jsx)(n.code,{children:"--unstable-features <UNSTABLE_FEATURES>"})," \u2014 Unstable features to enable for this current build."]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If non-empty, it disables unstable features required in crate manifests."}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--no-unstable-features"})," \u2014 Disable any unstable features required in crate manifests"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--oracle-resolver <ORACLE_RESOLVER>"})," \u2014 JSON RPC url to solve oracle calls"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--test-threads <TEST_THREADS>"})," \u2014 Number of threads used for running tests in parallel"]}),"\n",(0,i.jsxs)(n.p,{children:["Default value: ",(0,i.jsx)(n.code,{children:"4"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--format <FORMAT>"})," \u2014 Configure formatting of output"]}),"\n",(0,i.jsx)(n.p,{children:"Possible values:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"pretty"}),":\nPrint verbose output"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"terse"}),":\nDisplay one character per test"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"json"}),":\nOutput a JSON Lines document"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"-q"}),", ",(0,i.jsx)(n.code,{children:"--quiet"})," \u2014 Display one character per test instead of one line"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--no-fuzz"})," \u2014 Do not run fuzz tests (tests that have arguments)"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--only-fuzz"})," \u2014 Only run fuzz tests (tests that have arguments)"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--corpus-dir <CORPUS_DIR>"})," \u2014 If given, load/store fuzzer corpus from this folder"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--minimized-corpus-dir <MINIMIZED_CORPUS_DIR>"})," \u2014 If given, perform corpus minimization instead of fuzzing and store results in the given folder"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--fuzzing-failure-dir <FUZZING_FAILURE_DIR>"})," \u2014 If given, store the failing input in the given folder"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--fuzz-timeout <FUZZ_TIMEOUT>"})," \u2014 Maximum time in seconds to spend fuzzing (default: 1 seconds)"]}),"\n",(0,i.jsxs)(n.p,{children:["Default value: ",(0,i.jsx)(n.code,{children:"1"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--fuzz-max-executions <FUZZ_MAX_EXECUTIONS>"})," \u2014 Maximum number of executions to run for each fuzz test (default: 100000)"]}),"\n",(0,i.jsxs)(n.p,{children:["Default value: ",(0,i.jsx)(n.code,{children:"100000"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--fuzz-show-progress"})," \u2014 Show progress of fuzzing (default: false)"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--coverage"})," \u2014 Produce a coverage report."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Writes coverage data to the workspace target directory into ",(0,i.jsx)(n.code,{children:"target/coverage/<package-name>/lcov.info"})," or ",(0,i.jsx)(n.code,{children:"target/coverage/lcov.info"})," files, depending on whether we are dealing with a workspace."]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"--coverage-dir <COVERAGE_DIR>"})," \u2014 Override the directory where coverage files are written."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If not set, defaults to the workspace target directory."}),"\n",(0,i.jsx)(n.h2,{id:"nargo-fuzz",children:(0,i.jsx)(n.code,{children:"nargo fuzz"})}),"\n",(0,i.jsx)(n.p,{children:"Run the fuzzing harnesses for this program"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Usage:"})," ",(0,i.jsx)(n.code,{children:"nargo fuzz [OPTIONS] [FUZZING_HARNESS_NAME]"})]}),"\n",(0,i.jsx)(n.h6,{id:"arguments-5",children:(0,i.jsx)(n.strong,{children:"Arguments:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"<FUZZING_HARNESS_NAME>"})," \u2014 If given, only the fuzzing harnesses with names containing this string will be run"]}),"\n"]}),"\n",(0,i.jsx)(n.h6,{id:"options-12",children:(0,i.jsx)(n.strong,{children:"Options:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--corpus-dir <CORPUS_DIR>"})," \u2014 If given, load/store fuzzer corpus from this folder"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--minimized-corpus-dir <MINIMIZED_CORPUS_DIR>"})," \u2014 If given, perform corpus minimization instead of fuzzing and store results in the given folder"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--fuzzing-failure-dir <FUZZING_FAILURE_DIR>"})," \u2014 If given, store the failing input in the given folder"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--list-all"})," \u2014 List all available harnesses that match the name"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--show-output"})," \u2014 Display output of ",(0,i.jsx)(n.code,{children:"println"})," statements"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--num-threads <NUM_THREADS>"})," \u2014 The number of threads to use for fuzzing"]}),"\n",(0,i.jsxs)(n.p,{children:["Default value: ",(0,i.jsx)(n.code,{children:"1"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--exact"})," \u2014 Only run harnesses that match exactly"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--package <PACKAGE>"})," \u2014 The name of the package to run the command on. By default run on the first one found moving up along the ancestors of the current directory"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--workspace"})," \u2014 Run on all packages in the workspace"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--force"})," \u2014 Force a full recompilation"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--print-acir"})," \u2014 Display the ACIR for compiled circuit, including the Brillig bytecode"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--deny-warnings"})," \u2014 Treat all warnings as errors"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--silence-warnings"})," \u2014 Suppress warnings"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--debug-comptime-in-file <DEBUG_COMPTIME_IN_FILE>"}),' \u2014 Enable printing results of comptime evaluation: provide a path suffix for the module to debug, e.g. "',(0,i.jsx)(n.code,{children:"package_name/src/main.nr"}),'"']}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-underconstrained-check"})," \u2014 Flag to turn off the compiler check for under constrained values. Warning: This can improve c
1ompilation speed but can also lead to correctness errors. This check should always be run on production code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-brillig-constraints-check"})," \u2014 Flag to turn off the compiler check for missing Brillig call constraints. Warning: This can improve compilation speed but can also lead to correctness errors. This check should always be run on production code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--inliner-aggressiveness <INLINER_AGGRESSIVENESS>"})," \u2014 Setting to decide on an inlining strategy for Brillig functions. A more aggressive inliner should generate larger programs but more optimized A less aggressive inliner should generate smaller programs"]}),"\n",(0,i.jsxs)(n.p,{children:["Default value: ",(0,i.jsx)(n.code,{children:"9223372036854775807"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"-Z"}),", ",(0,i.jsx)(n.code,{children:"--unstable-features <UNSTABLE_FEATURES>"})," \u2014 Unstable features to enable for this current build."]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If non-empty, it disables unstable features required in crate manifests."}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--no-unstable-features"})," \u2014 Disable any unstable features required in crate manifests"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--oracle-resolver <ORACLE_RESOLVER>"})," \u2014 JSON RPC url to solve oracle calls"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--timeout <TIMEOUT>"})," \u2014 Maximum time in seconds to spend fuzzing (default: no timeout)"]}),"\n",(0,i.jsxs)(n.p,{children:["Default value: ",(0,i.jsx)(n.code,{children:"0"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--max-executions <MAX_EXECUTIONS>"})," \u2014 Maximum number of executions of ACIR and Brillig per harness (default: no limit)"]}),"\n",(0,i.jsxs)(n.p,{children:["Default value: ",(0,i.jsx)(n.code,{children:"0"})]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"nargo-info",children:(0,i.jsx)(n.code,{children:"nargo info"})}),"\n",(0,i.jsx)(n.p,{children:"Provides detailed information on each of a program's function (represented by a single circuit)"}),"\n",(0,i.jsx)(n.p,{children:"Current information provided per circuit: 1. The number of ACIR opcodes 2. Counts the final number gates in the circuit used by a backend"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Usage:"})," ",(0,i.jsx)(n.code,{children:"nargo info [OPTIONS]"})]}),"\n",(0,i.jsx)(n.h6,{id:"options-13",children:(0,i.jsx)(n.strong,{children:"Options:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--package <PACKAGE>"})," \u2014 The name of the package to run the command on. By default run on the first one found moving up along the ancestors of the current directory"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--workspace"})," \u2014 Run on all packages in the workspace"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--profile-execution"})," \u2014 Compile and execute the program in the Brillig VM, reporting the number of Brillig opcodes executed at runtime rather than the static opcode count of the compiled circuit. Useful for analyzing the runtime cost of unconstrained functions and identifying execution bottlenecks. It implies ",(0,i.jsx)(n.code,{children:"--force-brillig"}),": a constrained circuit has fully flattened control flow (e.g. loops and conditionals), so execution profiling is only meaningful for unconstrained code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"-p"}),", ",(0,i.jsx)(n.code,{children:"--prover-name <PROVER_NAME>"})," \u2014 The name of the toml file which contains the inputs for the prover"]}),"\n",(0,i.jsxs)(n.p,{children:["Default value: ",(0,i.jsx)(n.code,{children:"Prover"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--force"})," \u2014 Force a full recompilation"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--print-acir"})," \u2014 Display the ACIR for compiled circuit, including the Brillig bytecode"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--deny-warnings"})," \u2014 Treat all warnings as errors"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--silence-warnings"})," \u2014 Suppress warnings"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--debug-comptime-in-file <DEBUG_COMPTIME_IN_FILE>"}),' \u2014 Enable printing results of comptime evaluation: provide a path suffix for the module to debug, e.g. "',(0,i.jsx)(n.code,{children:"package_name/src/main.nr"}),'"']}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-underconstrained-check"})," \u2014 Flag to turn off the compiler check for under constrained values. Warning: This can improve c
1ompilation speed but can also lead to correctness errors. This check should always be run on production code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-brillig-constraints-check"})," \u2014 Flag to turn off the compiler check for missing Brillig call constraints. Warning: This can improve compilation speed but can also lead to correctness errors. This check should always be run on production code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--inliner-aggressiveness <INLINER_AGGRESSIVENESS>"})," \u2014 Setting to decide on an inlining strategy for Brillig functions. A more aggressive inliner should generate larger programs but more optimized A less aggressive inliner should generate smaller programs"]}),"\n",(0,i.jsxs)(n.p,{children:["Default value: ",(0,i.jsx)(n.code,{children:"9223372036854775807"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"-Z"}),", ",(0,i.jsx)(n.code,{children:"--unstable-features <UNSTABLE_FEATURES>"})," \u2014 Unstable features to enable for this current build."]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If non-empty, it disables unstable features required in crate manifests."}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--no-unstable-features"})," \u2014 Disable any unstable features required in crate manifests"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"nargo-lsp",children:(0,i.jsx)(n.code,{children:"nargo lsp"})}),"\n",(0,i.jsx)(n.p,{children:"Starts the Noir LSP server"}),"\n",(0,i.jsx)(n.p,{children:"Starts an LSP server which allows IDEs such as VS Code to display diagnostics in Noir source."}),"\n",(0,i.jsxs)(n.p,{children:["VS Code Noir Language Support: ",(0,i.jsx)(n.a,{href:"https://marketplace.visualstudio.com/items?itemName=noir-lang.vscode-noir",children:"https://marketplace.visualstudio.com/items?itemName=noir-lang.vscode-noir"})]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Usage:"})," ",(0,i.jsx)(n.code,{children:"nargo lsp"})]}),"\n",(0,i.jsx)(n.h2,{id:"nargo-expand",children:(0,i.jsx)(n.code,{children:"nargo expand"})}),"\n",(0,i.jsx)(n.p,{children:"Show the result of macro expansion"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Usage:"})," ",(0,i.jsx)(n.code,{children:"nargo expand [OPTIONS]"})]}),"\n",(0,i.jsx)(n.h6,{id:"options-14",children:(0,i.jsx)(n.strong,{children:"Options:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--package <PACKAGE>"})," \u2014 The name of the package to run the command on. By default run on the first one found moving up along the ancestors of the current directory"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--workspace"})," \u2014 Run on all packages in the workspace"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--force"})," \u2014 Force a full recompilation"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--print-acir"})," \u2014 Display the ACIR for compiled circuit, including the Brillig bytecode"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--deny-warnings"})," \u2014 Treat all warnings as errors"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--silence-warnings"})," \u2014 Suppress warnings"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--debug-comptime-in-file <DEBUG_COMPTIME_IN_FILE>"}),' \u2014 Enable printing results of comptime evaluation: provide a path suffix for the module to debug, e.g. "',(0,i.jsx)(n.code,{children:"package_name/src/main.nr"}),'"']}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-underconstrained-check"})," \u2014 Flag to turn off the compiler check for under constrained values. Warning: This can improve c
1ompilation speed but can also lead to correctness errors. This check should always be run on production code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-brillig-constraints-check"})," \u2014 Flag to turn off the compiler check for missing Brillig call constraints. Warning: This can improve compilation speed but can also lead to correctness errors. This check should always be run on production code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--inliner-aggressiveness <INLINER_AGGRESSIVENESS>"})," \u2014 Setting to decide on an inlining strategy for Brillig functions. A more aggressive inliner should generate larger programs but more optimized A less aggressive inliner should generate smaller programs"]}),"\n",(0,i.jsxs)(n.p,{children:["Default value: ",(0,i.jsx)(n.code,{children:"9223372036854775807"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"-Z"}),", ",(0,i.jsx)(n.code,{children:"--unstable-features <UNSTABLE_FEATURES>"})," \u2014 Unstable features to enable for this current build."]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If non-empty, it disables unstable features required in crate manifests."}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--no-unstable-features"})," \u2014 Disable any unstable features required in crate manifests"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"nargo-doc",children:(0,i.jsx)(n.code,{children:"nargo doc"})}),"\n",(0,i.jsx)(n.p,{children:"Builds documentation for the specified package or workspace."}),"\n",(0,i.jsx)(n.p,{children:"Note: this command is in development and functionality may change greatly with no warning."}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Usage:"})," ",(0,i.jsx)(n.code,{children:"nargo doc [OPTIONS]"})]}),"\n",(0,i.jsx)(n.h6,{id:"options-15",children:(0,i.jsx)(n.strong,{children:"Options:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--package <PACKAGE>"})," \u2014 The name of the package to run the command on. By default run on the first one found moving up along the ancestors of the current directory"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--workspace"})," \u2014 Run on all packages in the workspace"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--force"})," \u2014 Force a full recompilation"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--print-acir"})," \u2014 Display the ACIR for compiled circuit, including the Brillig bytecode"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--deny-warnings"})," \u2014 Treat all warnings as errors"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--silence-warnings"})," \u2014 Suppress warnings"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--debug-comptime-in-file <DEBUG_COMPTIME_IN_FILE>"}),' \u2014 Enable printing results of comptime evaluation: provide a path suffix for the module to debug, e.g. "',(0,i.jsx)(n.code,{children:"package_name/src/main.nr"}),'"']}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-underconstrained-check"})," \u2014 Flag to turn off the compiler check for under constrained values. Warning: This can improve c
1ompilation speed but can also lead to correctness errors. This check should always be run on production code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--skip-brillig-constraints-check"})," \u2014 Flag to turn off the compiler check for missing Brillig call constraints. Warning: This can improve compilation speed but can also lead to correctness errors. This check should always be run on production code"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--inliner-aggressiveness <INLINER_AGGRESSIVENESS>"})," \u2014 Setting to decide on an inlining strategy for Brillig functions. A more aggressive inliner should generate larger programs but more optimized A less aggressive inliner should generate smaller programs"]}),"\n",(0,i.jsxs)(n.p,{children:["Default value: ",(0,i.jsx)(n.code,{children:"9223372036854775807"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"-Z"}),", ",(0,i.jsx)(n.code,{children:"--unstable-features <UNSTABLE_FEATURES>"})," \u2014 Unstable features to enable for this current build."]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If non-empty, it disables unstable features required in crate manifests."}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--no-unstable-features"})," \u2014 Disable any unstable features required in crate manifests"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"--check"})," \u2014 Do not produce any output files, only check for broken links"]}),"\n",(0,i.jsxs)(n.p,{children:["Possible values: ",(0,i.jsx)(n.code,{children:"true"}),", ",(0,i.jsx)(n.code,{children:"false"})]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"nargo-generate-completion-script",children:(0,i.jsx)(n.code,{children:"nargo generate-completion-script"})}),"\n",(0,i.jsx)(n.p,{children:"Generates a shell completion script for your favorite shell"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Usage:"})," ",(0,i.jsx)(n.code,{children:"nargo generate-completion-script <SHELL>"})]}),"\n",(0,i.jsx)(n.h6,{id:"arguments-6",children:(0,i.jsx)(n.strong,{children:"Arguments:"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"<SHELL>"})," \u2014 The shell to generate completions for. One of: bash, elvish, fish, powershell, zsh"]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.small,{children:(0,i.jsxs)(n.i,{children:["\nThis document was generated automatically by\n",(0,i.jsx)(n.a,{href:"https://crates.io/crates/clap-markdown",children:(0,i.jsx)(n.code,{children:"clap-markdown"})}),".\n"]})})})]})}function h(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(t,{...e})}):t(e)}},28453(e,n,s){s.d(n,{R:()=>c,x:()=>d});var r=s(96540);const i={},l=r.createContext(i);function c(e){const n=r.useContext(l);return r.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),r.createElement(l.Provider,{value:n},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.