Skip to content

docs: update cli readme #2601

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ss2165 merged 1 commit into from
Oct 1, 2025
Merged

docs: update cli readme #2601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 18 additions & 10 deletions hugr-cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,28 @@ cargo install hugr-cli
This will install the `hugr` binary. Running `hugr --help` shows:

```
Validate a HUGR.
HUGR CLI tools.

Usage: hugr [OPTIONS] <INPUT>
Usage: hugr [OPTIONS] <COMMAND>

Arguments:
<INPUT>
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:
-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
-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
```


Expand Down
51 changes: 7 additions & 44 deletions hugr-cli/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,51 +9,14 @@
//! directory](https://doc.rust-lang.org/book/ch14-04-installing-binaries.html)
//! in your path.
//!
//! The CLI provides two subcommands:
//!
//! - `validate` for validating HUGR files.
//! - `mermaid` for visualizing HUGR files as mermaid diagrams.
//!
//! ### Validate
//!
//! Validate and visualize a HUGR file
//!
//! Usage: `hugr validate [OPTIONS] [INPUT]`
//!
//! ```text
//! Options:
//! -v, --verbose... Increase logging verbosity
//! -q, --quiet... Decrease logging verbosity
//! -h, --help Print help (see more with '--help')
//! -V, --version Print version
//!
//! Input:
//! --no-std Don't use standard extensions when validating hugrs. Prelude is still used.
//! -e, --extensions <EXTENSIONS> Paths to serialised extensions to validate against.
//! --hugr-json Read the input as a HUGR JSON file instead of an envelope
//! [INPUT] Input file. Defaults to `-` for stdin
//! The top level help can be accessed with:
//! ```sh
//! hugr --help
//! ```
//!
//! ### Mermaid
//!
//! Write HUGR as mermaid diagrams
//!
//! Usage: `hugr mermaid [OPTIONS] [INPUT]`
//!
//! ```text
//! Options:
//! --validate Validate before rendering, includes extension inference.
//! -o, --output <OUTPUT> Output file '-' for stdout [default: -]
//! -v, --verbose... Increase logging verbosity
//! -q, --quiet... Decrease logging verbosity
//! -h, --help Print help (see more with '--help')
//! -V, --version Print version
//!
//! Input:
//! --no-std Don't use standard extensions when validating hugrs. Prelude is still used.
//! -e, --extensions <EXTENSIONS> Paths to serialised extensions to validate against.
//! --hugr-json Read the input as a HUGR JSON file instead of an envelope
//! [INPUT] Input file. Defaults to `-` for stdin.
//! Refer to the help for each subcommand for more information, e.g.
//! ```sh
//! hugr validate --help
//! ```

use clap::{Parser, crate_version};
Expand Down Expand Up @@ -87,7 +50,7 @@ pub struct CliArgs {
#[derive(Debug, clap::Subcommand)]
#[non_exhaustive]
pub enum CliCommand {
/// Validate and visualize a HUGR file.
/// Validate a HUGR package.
Validate(validate::ValArgs),
/// Write standard extensions out in serialized form.
GenExtensions(extensions::ExtArgs),
Expand Down
Loading