From 42dcf10064bf96cadab378e6884f808f0c20fe6a Mon Sep 17 00:00:00 2001 From: atlas Date: Wed, 16 Sep 2026 19:02:42 +0200 Subject: [PATCH] swarm-logs-cli.md: regenerate from the binary, prettierignore it MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. --- .prettierignore | 1 + docs/tools/swarm-logs-cli.md | 26 +++++++++++++++----------- 2 files changed, 16 insertions(+), 11 deletions(-) diff --git a/.prettierignore b/.prettierignore index 8cfbf2f9..6a9b2fb4 100644 --- a/.prettierignore +++ b/.prettierignore @@ -7,6 +7,7 @@ docs/tools/hivectl-cli.md docs/tools/swarmctl-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. # prettier's `proseWrap: "preserve"` prevents prose reflow but not list-item diff --git a/docs/tools/swarm-logs-cli.md b/docs/tools/swarm-logs-cli.md index 29d72c6e..f6f1d2b1 100644 --- a/docs/tools/swarm-logs-cli.md +++ b/docs/tools/swarm-logs-cli.md @@ -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:** -- `` — The LogsQL query. A bare word is a full-text search for it. +* `` — 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 ` — Stop after this many records. +* `--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 ` — 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 ` — 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 + + +
-This document was generated automatically by -clap-markdown. + This document was generated automatically by + clap-markdown.