swarm-logs-cli.md: regenerate from the binary, prettierignore it
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:
parent
a39399f037
commit
42dcf10064
2 changed files with 16 additions and 11 deletions
|
|
@ -7,6 +7,7 @@
|
||||||
docs/tools/hivectl-cli.md
|
docs/tools/hivectl-cli.md
|
||||||
docs/tools/swarmctl-cli.md
|
docs/tools/swarmctl-cli.md
|
||||||
docs/tools/forge-cli.md
|
docs/tools/forge-cli.md
|
||||||
|
docs/tools/swarm-logs-cli.md
|
||||||
|
|
||||||
# Files with multi-line list-item continuations that prettier strips to col 0.
|
# Files with multi-line list-item continuations that prettier strips to col 0.
|
||||||
# prettier's `proseWrap: "preserve"` prevents prose reflow but not list-item
|
# prettier's `proseWrap: "preserve"` prevents prose reflow but not list-item
|
||||||
|
|
|
||||||
|
|
@ -4,8 +4,8 @@ This document contains the help content for the `swarm-logs` command-line progra
|
||||||
|
|
||||||
**Command Overview:**
|
**Command Overview:**
|
||||||
|
|
||||||
- [`swarm-logs`↴](#swarm-logs)
|
* [`swarm-logs`↴](#swarm-logs)
|
||||||
- [`swarm-logs query`↴](#swarm-logs-query)
|
* [`swarm-logs query`↴](#swarm-logs-query)
|
||||||
|
|
||||||
## `swarm-logs`
|
## `swarm-logs`
|
||||||
|
|
||||||
|
|
@ -15,7 +15,9 @@ query the swarm's log store from an agent
|
||||||
|
|
||||||
###### **Subcommands:**
|
###### **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`
|
## `swarm-logs query`
|
||||||
|
|
||||||
|
|
@ -25,17 +27,16 @@ Run a LogsQL query and print the matched log lines
|
||||||
|
|
||||||
###### **Arguments:**
|
###### **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:**
|
###### **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.
|
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
|
||||||
- `--format <FORMAT>` — What to print for each matched record
|
|
||||||
|
|
||||||
Default value: `message`
|
Default value: `message`
|
||||||
|
|
||||||
|
|
@ -45,6 +46,9 @@ Run a LogsQL query and print the matched log lines
|
||||||
- `json`:
|
- `json`:
|
||||||
The store's response body, unmodified, one JSON object per line
|
The store's response body, unmodified, one JSON object per line
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<hr/>
|
<hr/>
|
||||||
|
|
||||||
<small><i>
|
<small><i>
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue