Skip to main content

ish docs overview

Print the agent-facing mental model and traversal hints Usage: ish docs overview

ish docs list

List every doc page with its one-line description Usage: ish docs list

ish docs get-page

Print the full markdown for one page Usage: ish docs get-page <slug>

Arguments

slug
Page slug, e.g. concepts/study (see ish docs list) (required)
Keyword search across every doc page Usage: ish docs search <query>

Arguments

query
Search query (case-insensitive substring) (required)

Global flags

Every command accepts the global flags.
-V, --version
boolean
output the version number
-t, --token <token>
string
Auth token (or set ISH_TOKEN env var)
--token-file <path>
string
Read auth token from a file (preferred over —token / ISH_TOKEN)
--workspace <id>
string
Default workspace ID; per-subcommand —workspace overrides
--json
boolean
Output as JSON (auto-enabled when piped)
--get <field>
string
Extract a single field from the JSON response and print only its value (implies —json internally; supports dotted paths e.g. person.name)
--human
boolean
Force human-readable output even when stdout is piped (overrides JSON-when-piped auto-detection)
--fields <fields>
string
Comma-separated fields to include in JSON output (e.g. alias,name,status)
--verbose
boolean
Include full UUIDs and timestamps in JSON output
--no-color
boolean
Disable colored output (also honored: NO_COLOR env var)
-q, --quiet
boolean
Suppress progress messages on stderr (no-op for read commands that emit none)