docs: move the agent tool docs to 4-implementation/agent-tools
This commit is contained in:
parent
df8a82bc33
commit
aa227a95c1
1 changed files with 94 additions and 83 deletions
51
docs/4-implementation/agent-tools/swarm-logs-cli.md
Normal file
51
docs/4-implementation/agent-tools/swarm-logs-cli.md
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
# Command-Line Help for `swarm-logs`
|
||||
|
||||
This document contains the help content for the `swarm-logs` command-line program.
|
||||
|
||||
**Command Overview:**
|
||||
|
||||
* [`swarm-logs`↴](#swarm-logs)
|
||||
* [`swarm-logs query`↴](#swarm-logs-query)
|
||||
|
||||
## `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
|
||||
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in a new issue