CLI: backend
Complete help for farthershore backend and every subcommand.
farthershore backend
Usage: farthershore backend [options] [command]
Manage BYO backends and their runtime tokens
Options:
-h, --help display help for command
Commands:
list [options] [businessIdOrSlug] List backends for a business (id, scope, name, transport, status)
create [options] [businessIdOrSlug] Create a backend (default transport: direct)
bind [options] [businessIdOrSlug] <backend> Bind a logical backend to a direct upstream in one environment
delete [options] [businessIdOrSlug] <backendId> Delete a backend (revokes its runtime tokens). Requires --yes.
tokens Manage runtime tokens (fsrt_) for BYO backends
help [command] display help for command
farthershore backend list
Usage: farthershore backend list [options] [businessIdOrSlug]
List backends for a business (id, scope, name, transport, status)
Arguments:
businessIdOrSlug The business id, or a slug (slug lookup requires
business:read).
Options:
--env <environment> Only rows in this environment (name or id). Pass
'production' for the production scope; omit for every
scope.
-h, --help display help for command
Scope:
Backends and their runtime tokens are per-(business, environment) rows.
Without --env every scope is listed; each row carries scope (production |
environment), environmentId, and the environment name. Two rows for the same
declared backend — one production, one environment-scoped — are expected, and
both may be 'default': the single-default rule is per scope.
'production' (or 'prod') is a valid --env on EVERY backend verb, read and
write alike, and selects the live business — the same scope you get by
omitting --env. It is not a preview environment: it has no environment id and
no branch, which is why 'farthershore env list' shows it with id: null. The
words production/prod/main are reserved and cannot name a real environment.
farthershore backend create
Usage: farthershore backend create [options] [businessIdOrSlug]
Create a backend (default transport: direct)
Arguments:
businessIdOrSlug The business id, or a slug (slug lookup requires
business:read).
Options:
--name <name> Human-friendly backend name
--slug <slug> Stable slug (defaults to a slugified name)
--env <environment> Scope backend to an environment name or id. Pass
'production' (or omit) for the live business.
--transport <mode> Transport mode: direct | tunnel (default: "direct")
--runner <runner> embedded | sidecar
--runtime <runtime> Container/runtime descriptor
--origin-url <url> Builder origin URL (direct)
--default Mark this backend the business default
--idempotency-key <key> Required for this mutation. Generate it once and
reuse the exact value on retry.
--dry-run Preview the change without applying it.
-h, --help display help for command
farthershore backend bind
Usage: farthershore backend bind [options] [businessIdOrSlug] <backend>
Bind a logical backend to a direct upstream in one environment
Arguments:
businessIdOrSlug The business id, or a slug (slug lookup requires
business:read).
backend
Options:
--env <environment> Environment name or id. Pass 'production' (or omit) for
the live business.
--origin-url <url> Concrete direct upstream URL for this environment
--dry-run Preview the change without applying it.
-h, --help display help for command
farthershore backend delete
Usage: farthershore backend delete [options] [businessIdOrSlug] <backendId>
Delete a backend (revokes its runtime tokens). Requires --yes.
Arguments:
businessIdOrSlug The business id, or a slug (slug lookup requires
business:read).
backendId
Options:
--yes Skip confirmation; required for this destructive action
-h, --help display help for command
farthershore backend tokens
Usage: farthershore backend tokens [options] [command]
Manage runtime tokens (fsrt_) for BYO backends
Options:
-h, --help display help for command
Commands:
list [options] [businessIdOrSlug] List runtime tokens for a business
create [options] [businessIdOrSlug] Create a runtime token (returns FS_RUNTIME_TOKEN once)
rotate [options] [businessIdOrSlug] <tokenId> Rotate a runtime token (returns a fresh FS_RUNTIME_TOKEN once)
revoke [options] [businessIdOrSlug] <tokenId> Revoke a runtime token. Requires --yes.
help [command] display help for command
farthershore backend tokens list
Usage: farthershore backend tokens list [options] [businessIdOrSlug]
List runtime tokens for a business
Arguments:
businessIdOrSlug The business id, or a slug (slug lookup requires
business:read).
Options:
--env <environment> Only rows in this environment (name or id). Pass
'production' for the production scope; omit for every
scope.
-h, --help display help for command
Scope:
Backends and their runtime tokens are per-(business, environment) rows.
Without --env every scope is listed; each row carries scope (production |
environment), environmentId, and the environment name. Two rows for the same
declared backend — one production, one environment-scoped — are expected, and
both may be 'default': the single-default rule is per scope.
'production' (or 'prod') is a valid --env on EVERY backend verb, read and
write alike, and selects the live business — the same scope you get by
omitting --env. It is not a preview environment: it has no environment id and
no branch, which is why 'farthershore env list' shows it with id: null. The
words production/prod/main are reserved and cannot name a real environment.
farthershore backend tokens create
Usage: farthershore backend tokens create [options] [businessIdOrSlug]
Create a runtime token (returns FS_RUNTIME_TOKEN once)
Arguments:
businessIdOrSlug The business id, or a slug (slug lookup requires
business:read).
Options:
--env <environment> Scope token to an environment name or id. Pass
'production' (or omit) for the live business.
--backend <backendSlugOrId> Bind token to a specific backend, by slug or id
(resolved in --env, falling back to the
production row)
--kind <kind> live | test (defaults from env scope)
--operations <list> Comma-separated operations: gateway_verification
| metering | health | tunnel. Default: core's
DEFAULT_OPERATIONS. Use tunnel for tunnel
backends.
--meters <list> Comma-separated allowed meters (default: all
business meters)
--routes <list> Comma-separated allowed routes
--idempotency-key <key> Required for this mutation. Generate it once and
reuse the exact value on retry.
-h, --help display help for command
farthershore backend tokens rotate
Usage: farthershore backend tokens rotate [options] [businessIdOrSlug] <tokenId>
Rotate a runtime token (returns a fresh FS_RUNTIME_TOKEN once)
Arguments:
businessIdOrSlug The business id, or a slug (slug lookup requires
business:read).
tokenId
Options:
--idempotency-key <key> Required for this mutation. Generate it once and
reuse the exact value on retry.
-h, --help display help for command
farthershore backend tokens revoke
Usage: farthershore backend tokens revoke [options] [businessIdOrSlug] <tokenId>
Revoke a runtime token. Requires --yes.
Arguments:
businessIdOrSlug The business id, or a slug (slug lookup requires
business:read).
tokenId
Options:
--yes Skip confirmation; required for this destructive action
-h, --help display help for command