CLI: docs
Complete help for farthershore docs and every subcommand.
farthershore docs
Usage: farthershore docs [options] [command]
Browse public platform documentation as a read-only filesystem (no login)
Options:
--stage Read stage docs instead of production
(independent of --api-url)
-h, --help display help for command
Commands:
ls|list [path] List collections, a section directory, or
the headings in a page
tree [path] Expand a collection or directory recursively
into its sections and pages
read|get [options] <path-or-url> Read a complete page by virtual path,
canonical slug or official docs URL
search [options] <query> Search literal text; results include
traversal paths and section links
collection <id> Read the entire collection corpus, without
truncation
help [command] display help for command
farthershore docs ls
Usage: farthershore docs ls|list [options] [path]
List collections, a section directory, or the headings in a page
Options:
-h, --help display help for command
farthershore docs tree
Usage: farthershore docs tree [options] [path]
Expand a collection or directory recursively into its sections and pages
Options:
-h, --help display help for command
farthershore docs read
Usage: farthershore docs read|get [options] <path-or-url>
Read a complete page by virtual path, canonical slug or official docs URL
Options:
--section <heading-or-anchor> Read this heading and all its child sections;
no truncation
-h, --help display help for command
farthershore docs search
Usage: farthershore docs search [options] <query>
Search literal text; results include traversal paths and section links
Options:
--collection <id> Search only this collection
--limit <count> Maximum results (1–100) (default: "20")
-h, --help display help for command
farthershore docs collection
Usage: farthershore docs collection [options] <id>
Read the entire collection corpus, without truncation
Options:
-h, --help display help for command