hugr-cli

hugr CLI tool for common tasks on serialised 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:

Validate a HUGR.

Usage: hugr [OPTIONS] <INPUT>

Arguments:
  <INPUT>

Options:
  -m, --mermaid      Visualise with mermaid.
  -n, --no-validate  Skip validation.
  -v, --verbose...   Increase logging verbosity
  -q, --quiet...     Decrease logging verbosity
  -h, --help         Print help
  -V, --version      Print version

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).