42dcf10064
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.
1.5 KiB
Command-Line Help for swarm-logs
This document contains the help content for the swarm-logs command-line program.
Command Overview:
swarm-logs
query the swarm's log store from an agent
Usage: swarm-logs <COMMAND>
Subcommands:
query— Run a LogsQL query and print the matched log lines
swarm-logs query
Run a LogsQL query and print the matched log lines
Usage: swarm-logs query [OPTIONS] <LOGSQL>
Arguments:
-
<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.
Options:
-
--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 recordDefault value:
messagePossible values:
message: One log message per line — the_msgfield and nothing elsejson: The store's response body, unmodified, one JSON object per line
This document was generated automatically by
clap-markdown.