Global CLI options
Global authentication, context and output options.
Start here (agents):
farthershore docs ls --format json
Browse collections, expand docs tree <collection>, then docs read <path>.
farthershore operations list --format json
The machine-readable catalog of EVERY platform operation — for each:
its class (contract = author in the repo | operate = call it here),
the scope it needs, and the exact CLI command. Read this first to
discover what exists rather than guessing at commands.
Add --format json to any command for the agent output envelope.
Usage: farthershore [options] [command]
FartherShore CLI — agent-friendly commands for business operations
Options:
-V, --cli-version output the version number
--api-url <url> Override API base URL
--organization <id-or-slug> Use this organization for the current command
--format <format> Output format. Use --format json for
machine-readable agent output
--no-input Never prompt; fail fast in non-interactive
(agent) use
-h, --help display help for command
Commands:
auth Inspect CLI identity and select an organization
login [options] Authenticate the CLI without placing credentials
in argv
logout Revoke the current CLI session and clear stored
credentials
skills Manage the platform-verified Farther Shore agent
skills
docs [options] Browse public platform documentation as a
read-only filesystem (no login)
business Business bootstrap, status, release, and
presentation metadata
apply-timeline Inspect the Apply Timeline: repo-triggered
manifest applies (PRs, pushes, releases), checks,
diffs, apply phases
proposal
env Manage business environments (preview branches,
prod)
plan Plan operations: list code-managed plans and
migrate subscribers
commercial-release Inspect immutable commercial release manifests
persona Mint and manage test-env personas (test API keys)
usage Usage observability for a business
analytics Query the business event archive
operations Machine-readable catalog of repository-owned and
platform-operated actions
organization Manage builder organizations and team membership
token Manage organization-owned MakerTokens (signed-in
user CLI sessions only)
stripe Read a business's Stripe connection and remove a
per-business override (connecting is
browser-only)
service-account Manage subscriber-owned service accounts using an
ephemeral portal consumer session
limit Manage subscriber-owned usage limits with a
portal consumer session
audit-log Read and export builder audit logs
notifications Read notifications and manage delivery
preferences
backend Manage BYO backends and their runtime tokens
frontend Managed Frontend Hosting: status/rollback/local
preview (deploys are Git-triggered)
webhook Manage outbound webhook endpoints
agents Enable, disable, and inspect a business's
operating agents
bulletin Read and hand off the operating agents' bulletin
board
promo-code Manage API-controlled checkout promo codes
consumer Manage business users/consumers
variables Manage FS_PUBLIC_ bundle variables and write-only
secrets (the name is the class: FS_PUBLIC_ =
public, everything else = secret)
agreements
tax-settings Read and update Stripe Tax settings for a
business
resource-count Report subscription resource counts
denial Explain gateway denial decisions
dependents Inspect active business route dependents
workflow-control Preview replay and config rollback operations
automation Manage platform automation rules
knowledge List platform and business knowledge resources
link [options] [business] Target this directory at a business so later
commands can omit it (like `railway link`). Omit
the argument to show what is currently targeted.
unlink Stop targeting a business from this directory.
create Create local FartherShore project components
import Import external definitions into FartherShore
authoring
build [options] Build the business/ program into a Manifest IR
envelope
validate [options] Validate the business/ program the way the PR
check does, before pushing
workflows Inspect durable lifecycle workflow executions
(list / show)
help [command] display help for command