hugr-cli

hugr CLI tool for common tasks on serialized HUGR (e.g. validation, visualisation).

Refer to the main HUGR crate for more information.

Usage

Install using cargo:

cargo install hugr-cli

This will install the hugr binary. Running hugr --help shows:

HUGR CLI tools.

Usage: hugr [OPTIONS] <COMMAND>

Commands:
  validate        Validate a HUGR package
  gen-extensions  Write standard extensions out in serialized form
  mermaid         Write HUGR as mermaid diagrams
  convert         Convert between different HUGR envelope formats
  help            Print this message or the help of the given subcommand(s)

Options:
  -v, --verbose...  Increase logging verbosity
  -q, --quiet...    Decrease logging verbosity
  -h, --help        Print help
  -V, --version     Print version

Refer to the help for each subcommand for more information, e.g.

hugr validate --help

To extend the CLI you can also add the project as a library dependency:

cargo add hugr-cli

Please read the API documentation here.

Recent Changes

See CHANGELOG for a list of changes. The minimum supported rust version will only change on major releases.

Development

See DEVELOPMENT.md for instructions on setting up the development environment.

License

This project is licensed under Apache License, Version 2.0 (LICENSE or http://www.apache.org/licenses/LICENSE-2.0).