diff --git a/.github/workflows/mdbook.yml b/.github/workflows/mdbook.yml index a1e2ddf1..165d1cc4 100644 --- a/.github/workflows/mdbook.yml +++ b/.github/workflows/mdbook.yml @@ -21,6 +21,7 @@ jobs: - uses: actions/checkout@v4 with: sparse-checkout: | + book.toml snops_book index.html diff --git a/crates/xtask/src/main.rs b/crates/xtask/src/main.rs index 55b4395d..2c39617b 100644 --- a/crates/xtask/src/main.rs +++ b/crates/xtask/src/main.rs @@ -43,7 +43,11 @@ fn try_main() -> Result<()> { fn clipages(sh: &Shell) -> Result<()> { cmd!(sh, "cargo run -p snarkos-aot --features=docpages -- md").run()?; cmd!(sh, "cargo run -p snops --features=docpages -- md").run()?; - cmd!(sh, "cargo run -p snops-agent --features=docpages -- md").run()?; + cmd!( + sh, + "cargo run -p snops-agent --features=docpages -- --id foo md" + ) + .run()?; cmd!(sh, "cargo run -p snops-cli --features=docpages -- md").run()?; Ok(()) } diff --git a/snops_book/user_guide/clis/SNOPS_AGENT.md b/snops_book/user_guide/clis/SNOPS_AGENT.md index cf51f610..d5a40e54 100644 --- a/snops_book/user_guide/clis/SNOPS_AGENT.md +++ b/snops_book/user_guide/clis/SNOPS_AGENT.md @@ -10,7 +10,7 @@ This document contains the help content for the `snops-agent` command-line progr ## `snops-agent` -**Usage:** `snops-agent [OPTIONS] ` +**Usage:** `snops-agent [OPTIONS] --id ` ###### **Subcommands:** @@ -20,9 +20,9 @@ This document contains the help content for the `snops-agent` command-line progr ###### **Options:** * `--endpoint ` — Control plane endpoint address (IP, or wss://host, http://host) -* `--id ` +* `--id ` — Agent ID, used to identify the agent in the network * `--private-key-file ` — Locally provided private key file, used for envs where private keys are locally provided -* `--labels ` +* `--labels ` — Labels to attach to the agent, used for filtering and grouping * `--path ` — Path to the directory containing the stored data and configuration Default value: `./snops-data`