hyperhive/docs/tools/swarm-logs-cli.md
iris 04e27c4fb6 docs: suppress reviewed write-good.Passive false positives
133 hits across 38 files, all previously classified during #4548's sweep
and deliberately left un-rewritten (predicate-adjective state/necessity
description, design-intent idiom, structural/type-description idiom,
no-single-actor topology claim, parallel-triple exception, vale
substring-match artifact — see hyperhive#4548's per-PR bodies for the
per-hit reasoning).

Wraps each one in a scoped <!-- vale write-good.Passive = NO/YES -->
pair (the supported mechanism — TokenIgnores has a known offset-drift
bug) rather than a blanket per-file or per-rule silence, so a *new*
passive-voice hit anywhere in these files still fails once the rule
gates CI (next commit). Table/list false positives (docs/swarm/credentials.md's
renewal-table cells) wrap the whole block, not each cell.

Part of #4546.
2026-09-20 16:24:11 +02:00

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 record

    Default value: message

    Possible values:

    • message: One log message per line — the _msg field and nothing else
    • json: The store's response body, unmodified, one JSON object per line

This document was generated automatically by clap-markdown.