Skip to content

CLI Commands

These flags apply to all subcommands:

FlagDescription
--error-format <fmt>Diagnostic output format: human (default), json, or short. See Diagnostics & Warnings
--no-configDisable achronyme.toml loading. All values come from CLI flags and defaults

Scaffolds a new Achronyme project with achronyme.toml, source directory, and .gitignore.

Terminal window
ach init my-circuit
ach init my-app --template vm
ArgumentDescription
<name>Project name (must match [a-zA-Z_][a-zA-Z0-9_-]*)
FlagDescription
--template <tpl>Project template: circuit (default), vm, or prove
  • circuit — A standalone circuit with public/witness declarations and assert_eq
  • vm — A general-purpose program with print()
  • prove — A mixed program with an inline prove {} block
my-circuit/
├── achronyme.toml
├── src/
│ └── main.ach
└── .gitignore

See Project Configuration for the achronyme.toml reference.


Runs an Achronyme source file (.ach) or compiled binary (.achb).

Terminal window
ach run script.ach
ach run script.achb
ach run # uses [project].entry from achronyme.toml

If <path> is omitted, the CLI resolves the entry file from [project].entry in achronyme.toml.

FlagDescription
--stress-gcRun GC on every allocation (for testing). See Stress GC Mode
--max-heap <size>Set maximum heap size (e.g., 256M, 1G, 512K). Raises HeapLimitExceeded if exceeded
--gc-statsPrint GC statistics to stderr after execution. See GC Statistics
--prove-backend <backend>Backend for prove {} blocks: r1cs (default) or plonkish
Terminal window
ach run hello.ach
ach run hello.ach --prove-backend plonkish
ach run hello.ach --max-heap 256M --gc-stats
ach run # from project with achronyme.toml

Compiles an Achronyme circuit source file into R1CS/Plonkish constraints and generates a witness.

Terminal window
ach circuit circuit.ach --inputs "x=42,y=7"
ach circuit --inputs "x=42,y=7" # uses entry from achronyme.toml

See Circuit Options for all available flags.


Compiles an Achronyme source file into a binary (.achb) that can be run with ach run.

Terminal window
ach compile script.ach --output script.achb
ach compile --output script.achb # uses entry from achronyme.toml
FlagDescription
--output <path>Output file path (optional — can be set in [build.output].binary in achronyme.toml)

Disassembles an Achronyme source file or binary, showing the bytecode instructions.

Terminal window
ach disassemble script.ach
ach disassemble # uses entry from achronyme.toml

Starts an interactive Read-Eval-Print loop. (Not yet implemented.)