vinzenz/hyperhive
vinzenz/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

hive-forge, hivectl, swarmctl: fix clap help passive voice, regen docs

Browse source 
Rewrites every write-good.Passive hit in the hive-forge clap help text
into terse, imperative, active voice (meaning unchanged) and drops
clap-markdown's own fixed footer ('This document was generated
automatically by...') via MarkdownOptions::show_footer(false), since
that string isn't ours to reword and vale flagged it too.

docs/tools/{hivectl,swarmctl,forge}-cli.md are generated from each
crate's clap tree (see hive-forge/src/main.rs's MarkdownDocs verb) —
regenerated here from the fixed source, not hand-edited.

Refs #4549
This commit is contained in:
atlas 2026-09-20 05:38:30 +02:00 • committed by mara
commit f0e3ed04d3
18 changed files with 87 additions and 89 deletions
Download patch file Download diff file Expand all files Collapse all files

8
hivectl/src/cli.rs
View file

@ -49,8 +49,8 @@ pub enum Cmd {
/// GitHub account provisioning.
///
/// Store an operator-supplied personal access token (PAT) for an agent
/// so its `gh` and git can authenticate. No account is created — the
/// PAT is for an existing GitHub account.
/// so its `gh` and git can authenticate. Creates no account — the PAT
/// is for an existing GitHub account.
Github {
#[command(subcommand)]
cmd: GithubCmd,
@ -551,7 +551,7 @@ pub enum AgentCmd {
/// takes no value — it resumes the cwd's latest session, which
/// is the harness's, so choom never uses it; this flag matches
/// the claude flag it maps to). Omit for a fresh blank session.
/// A value is required when the flag is given.
/// Requires a value.
#[arg(long = "resume", value_name = "SESSION")]
resume_session: Option<String>,
},
@ -662,7 +662,7 @@ pub enum SnapshotCmd {
/// Stream a snapshot to the swarm's snapshot store over the
/// WireGuard mesh — the network half of the migration transport.
///
/// Nothing is staged locally: `btrfs send` writes straight into the
/// Stages nothing locally: `btrfs send` writes straight into the
/// connection, so a multi-gigabyte agent needs no scratch space on
/// this host. The mesh is the authentication (cryptokey routing
/// binds the sender's address to its key), so there is no credential

6
hivectl/src/main.rs
View file

@ -127,7 +127,11 @@ async fn main() -> Result<()> {
Cmd::Start { scope, no_wait } => start(&socket, scope.to_scope(), no_wait).await,
Cmd::Restart { scope, graceful } => restart(&socket, scope.to_scope(), graceful).await,
Cmd::MarkdownDocs => {
print!("{}", clap_markdown::help_markdown::<Cli>());
// `show_footer(false)`: drop clap-markdown's own fixed
// "This document was generated automatically by..." footer —
// it's the one string in this doc that isn't ours to reword.
let options = clap_markdown::MarkdownOptions::new().show_footer(false);
print!("{}", clap_markdown::help_markdown_custom::<Cli>(&options));
Ok(())
}
Cmd::Open { target } => open_url(&socket, target).await,