Command-Line Help for powdr

This document contains the help content for the powdr command-line program.

Command Overview:

powdr

Usage: powdr [COMMAND]

Subcommands:
  • pil — Runs compilation and witness generation for .pil and .asm files. First converts .asm files to .pil, if needed. Then converts the .pil file to json and generates fixed and witness column data files
  • rust — Compiles (no-std) rust code to riscv assembly, then to powdr assembly and finally to PIL and generates fixed and witness columns. Needs rustup target add riscv32imac-unknown-none-elf
  • riscv-asm — Compiles riscv assembly to powdr assembly and then to PIL and generates fixed and witness columns
  • prove —
  • setup —
  • reformat — Parses and prints the PIL file on stdout
  • optimize-pil — Optimizes the PIL file and outputs it on stdout
Options:
  • --markdown-help

powdr pil

Runs compilation and witness generation for .pil and .asm files. First converts .asm files to .pil, if needed. Then converts the .pil file to json and generates fixed and witness column data files

Usage: powdr pil [OPTIONS] <FILE>

Arguments:
  • <FILE> — Input file
Options:

  • --field <FIELD> — The field to use

    Default value: gl

    Possible values: gl, bn254

  • -o, --output-directory <OUTPUT_DIRECTORY> — Output directory for the PIL file, json file and fixed and witness column data

    Default value: .

  • -w, --witness-values <WITNESS_VALUES> — Path to a CSV file containing externally computed witness values

  • -i, --inputs <INPUTS> — Comma-separated list of free inputs (numbers). Assumes queries to have the form ("input", )

    Default value: ``

  • -f, --force — Force overwriting of PIL output file

    Default value: false

  • -p, --prove-with <PROVE_WITH> — Generate a proof with a given backend

    Possible values: estark, pil-stark-cli

  • --export-csv — Generate a CSV file containing the fixed and witness column values. Useful for debugging purposes

    Default value: false

  • --csv-mode <CSV_MODE> — How to render field elements in the csv file

    Default value: hex

    Possible values: i, ui, hex

  • -j, --just-execute — Just execute in the RISCV/Powdr executor

    Default value: false

powdr rust

Compiles (no-std) rust code to riscv assembly, then to powdr assembly and finally to PIL and generates fixed and witness columns. Needs rustup target add riscv32imac-unknown-none-elf

Usage: powdr rust [OPTIONS] <FILE>

Arguments:
  • <FILE> — Input file (rust source file) or directory (containing a crate)
Options:

  • --field <FIELD> — The field to use

    Default value: gl

    Possible values: gl, bn254

  • -i, --inputs <INPUTS> — Comma-separated list of free inputs (numbers)

    Default value: ``

  • -o, --output-directory <OUTPUT_DIRECTORY> — Directory for output files

    Default value: .

  • -f, --force — Force overwriting of files in output directory

    Default value: false

  • -p, --prove-with <PROVE_WITH> — Generate a proof with a given backend

    Possible values: estark, pil-stark-cli

  • --coprocessors <COPROCESSORS> — Comma-separated list of coprocessors

  • -j, --just-execute — Just execute in the RISCV/Powdr executor

    Default value: false

powdr riscv-asm

Compiles riscv assembly to powdr assembly and then to PIL and generates fixed and witness columns

Usage: powdr riscv-asm [OPTIONS] <FILES>...

Arguments:
  • <FILES> — Input files
Options:

  • --field <FIELD> — The field to use

    Default value: gl

    Possible values: gl, bn254

  • -i, --inputs <INPUTS> — Comma-separated list of free inputs (numbers)

    Default value: ``

  • -o, --output-directory <OUTPUT_DIRECTORY> — Directory for output files

    Default value: .

  • -f, --force — Force overwriting of files in output directory

    Default value: false

  • -p, --prove-with <PROVE_WITH> — Generate a proof with a given backend

    Possible values: estark, pil-stark-cli

  • --coprocessors <COPROCESSORS> — Comma-separated list of coprocessors

  • -j, --just-execute — Just execute in the RISCV/Powdr executor

    Default value: false

powdr prove

Usage: powdr prove [OPTIONS] --backend <BACKEND> <FILE>

Arguments:
  • <FILE> — Input PIL file
Options:

  • -d, --dir <DIR> — Directory to find the committed and fixed values

    Default value: .

  • --field <FIELD> — The field to use

    Default value: gl

    Possible values: gl, bn254

  • -b, --backend <BACKEND> — Generate a proof with a given backend

    Possible values: estark, pil-stark-cli

  • --proof <PROOF> — File containing previously generated proof for aggregation

  • --params <PARAMS> — File containing previously generated setup parameters

powdr setup

Usage: powdr setup [OPTIONS] --backend <BACKEND> <SIZE>

Arguments:
  • <SIZE> — Size of the parameters
Options:

  • -d, --dir <DIR> — Directory to output the generated parameters

    Default value: .

  • --field <FIELD> — The field to use

    Default value: gl

    Possible values: gl, bn254

  • -b, --backend <BACKEND> — Generate a proof with a given backend

    Possible values: estark, pil-stark-cli

powdr reformat

Parses and prints the PIL file on stdout

Usage: powdr reformat <FILE>

Arguments:
  • <FILE> — Input file

powdr optimize-pil

Optimizes the PIL file and outputs it on stdout

Usage: powdr optimize-pil [OPTIONS] <FILE>

Arguments:
  • <FILE> — Input file
Options:

  • --field <FIELD> — The field to use

    Default value: gl

    Possible values: gl, bn254

This document was generated automatically by clap-markdown.