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

swarm-logs-cli.md: regenerate from the binary, prettierignore it

Browse source 
The committed doc was stale (missing help text under --limit/--format
that the binary's clap-markdown output now includes). Regenerated with
the documented command. While at it: docs/tools/swarm-logs-cli.md was
never added to .prettierignore alongside its three siblings, so nix fmt
silently reformatted it back to a stale layout right after
regeneration — the exact failure mode .prettierignore's own comment
warns about. Added it so the *-docs-fresh check in nix/checks.nix stays
satisfiable.
This commit is contained in:
atlas 2026-09-16 19:02:42 +02:00 • committed by mara
commit 42dcf10064
2 changed files with 16 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

26
docs/tools/swarm-logs-cli.md
View file

@ -4,8 +4,8 @@ This document contains the help content for the `swarm-logs` command-line progra
**Command Overview:**
- [`swarm-logs`↴](#swarm-logs)
- [`swarm-logs query`↴](#swarm-logs-query)
* [`swarm-logs`↴](#swarm-logs)
* [`swarm-logs query`↴](#swarm-logs-query)
## `swarm-logs`
@ -15,7 +15,9 @@ query the swarm's log store from an agent
###### **Subcommands:**
- `query` — Run a LogsQL query and print the matched log lines
* `query` — Run a LogsQL query and print the matched log lines
## `swarm-logs query`
@ -25,17 +27,16 @@ Run a LogsQL query and print the matched log lines
###### **Arguments:**
- `<LOGSQL>` — The LogsQL query. A bare word is a full-text search for it.
* `<LOGSQL>` — The LogsQL query. A bare word is a full-text search for it.
Quote it: LogsQL uses characters the shell also claims, and an unquoted `|` pipes this command into the rest of your query instead of sending it.
Quote it: LogsQL uses characters the shell also claims, and an unquoted `|` pipes this command into the rest of your query instead of sending it.
###### **Options:**
- `--limit <LIMIT>` — Stop after this many records.
* `--limit <LIMIT>` — Stop after this many records.
Unset means the store's own default. Worth setting on a broad query — nothing between here and the store narrows one, so a bare word matches across every hive in the swarm.
- `--format <FORMAT>` — What to print for each matched record
Unset means the store's own default. Worth setting on a broad query — nothing between here and the store narrows one, so a bare word matches across every hive in the swarm.
* `--format <FORMAT>` — What to print for each matched record
Default value: `message`
@ -45,9 +46,12 @@ Run a LogsQL query and print the matched log lines
- `json`:
The store's response body, unmodified, one JSON object per line
<hr/>
<small><i>
This document was generated automatically by
<a href="https://crates.io/crates/clap-markdown"><code>clap-markdown</code></a>.
This document was generated automatically by
<a href="https://crates.io/crates/clap-markdown"><code>clap-markdown</code></a>.
</i></small>