CLI: business
Complete help for farthershore business and every subcommand.
farthershore business
Usage: farthershore business [options] [command]
Business bootstrap, status, release, and presentation metadata
Options:
-h, --help display help for command
Commands:
list [options] List businesses in the current org
show [options] [businessIdOrName] Show a business
routes [options] [businessIdOrName] List a business's compiled routes
subdomain-check <slug> Check whether a slug is free to use as a business subdomain before creating it
config-attempts [businessIdOrName] List rejected configuration attempts for a business
contract [options] [businessIdOrName] Show a business's accepted contract synopsis
status [options] [businessIdOrName] Show lifecycle, release, and exact edge-generation coherence for one environment.
rbac [options] [businessIdOrName] Show a business's Managed-RBAC state: the platform `rbacEnabled` flag.
create [options] <slug> Create a new business and provision its managed GitHub repo
update [options] [businessIdOrName] Update business presentation metadata
publish [options] [businessIdOrName] Publish a draft business (make it live) and cut a versioned release with an auto-computed semver. Requires at least one plan, a bound backend, and a verified Stripe connection.
rollback [options] [businessIdOrName] [workflowExecutionId] Roll back a prior business publish workflow
preview-env Configure automatic preview environment creation for a business
docs Enable or disable docs publishing for a business
help [command] display help for command
farthershore business list
Usage: farthershore business list [options]
List businesses in the current org
Options:
--filter <field=value> Exact field filter; repeat for AND. Fields: id,
name, displayName, subdomain, status. (default: [])
--sort <field[:asc|desc]> Server-side sort (default asc). Fields: id, name,
displayName, createdAt, updatedAt.
--search <text> Server-side case-insensitive text search.
-h, --help display help for command
farthershore business show
Usage: farthershore business show [options] [businessIdOrName]
Show a business
Options:
--env <env> Environment scope (preview branch name)
-h, --help display help for command
farthershore business routes
Usage: farthershore business routes [options] [businessIdOrName]
List a business's compiled routes
Options:
--env <env> Environment scope (preview branch name)
-h, --help display help for command
farthershore business subdomain-check
Usage: farthershore business subdomain-check [options] <slug>
Check whether a slug is free to use as a business subdomain before creating it
Options:
-h, --help display help for command
farthershore business config-attempts
Usage: farthershore business config-attempts [options] [businessIdOrName]
List rejected configuration attempts for a business
Options:
-h, --help display help for command
farthershore business contract
Usage: farthershore business contract [options] [businessIdOrName]
Show a business's accepted contract synopsis
Options:
--env <env> Environment scope (preview branch name)
-h, --help display help for command
farthershore business status
Usage: farthershore business status [options] [businessIdOrName]
Show lifecycle, release, and exact edge-generation coherence for one
environment.
Options:
--env <env> Environment scope (defaults to production)
-h, --help display help for command
farthershore business rbac
Usage: farthershore business rbac [options] [command] [businessIdOrName]
Show a business's Managed-RBAC state: the platform `rbacEnabled` flag.
Options:
--env <env> Environment scope (preview branch name)
-h, --help display help for command
Commands:
enable [businessIdOrName] Enable Managed RBAC for a business (platform-owned
flag).
disable [businessIdOrName] Disable Managed RBAC for a business
(platform-owned flag).
subjects List a business's custom permission subjects.
Subjects are repo-owned: declare a
permission-carrying `fs.group(id, routes, {
permission })` in business/ and run `farthershore
validate` + push to change them
farthershore business rbac enable
Usage: farthershore business rbac enable [options] [businessIdOrName]
Enable Managed RBAC for a business (platform-owned flag).
Options:
-h, --help display help for command
farthershore business rbac disable
Usage: farthershore business rbac disable [options] [businessIdOrName]
Disable Managed RBAC for a business (platform-owned flag).
Options:
-h, --help display help for command
farthershore business rbac subjects
Usage: farthershore business rbac subjects [options] [command]
List a business's custom permission subjects. Subjects are repo-owned: declare a
permission-carrying `fs.group(id, routes, { permission })` in business/ and run
`farthershore validate` + push to change them
Options:
-h, --help display help for command
Commands:
list [businessIdOrName] List the raw permission subjects subscriber
organizations can assemble into their own roles
(repo-owned: authored via fs.group permission config
in business/).
help [command] display help for command
farthershore business rbac subjects list
Usage: farthershore business rbac subjects list [options] [businessIdOrName]
List the raw permission subjects subscriber organizations can assemble into
their own roles (repo-owned: authored via fs.group permission config in
business/).
Options:
-h, --help display help for command
farthershore business create
Usage: farthershore business create [options] <slug>
Create a new business and provision its managed GitHub repo
Options:
--display-name <displayName> Human-friendly business name
--description <description>
--docs Enable docs for this business (default when
omitted).
--no-docs Opt out of docs for this business.
--idempotency-key <key> Required for this mutation. Generate it once and
reuse the exact value on retry.
-h, --help display help for command
farthershore business update
Usage: farthershore business update [options] [businessIdOrName]
Update business presentation metadata
Options:
--display-name <displayName>
--description <description>
--icon-url <url> Set the square icon/favicon URL
--icon-file <path> Upload a local PNG, JPEG, or WEBP square icon
--clear-icon Remove the current icon asset
--logo-url <url> Set the wordmark/logo URL
--logo-file <path> Upload a local PNG, JPEG, or WEBP wordmark/logo
--clear-logo Remove the current logo asset
--key-prefix <prefix> White-label prefix for subscriber API keys (fsk_
→ e.g. acme_). 2-12 lowercase letters/digits;
fs/fsk/fsc/fsm reserved.
--clear-key-prefix Reset the subscriber API key prefix to the
default (fsk).
--list-on-org-page Show this product on the organization's public
page (/organization/<slug>). Products are listed
by default.
--unlist-from-org-page Hide this product from the organization's public
page. Does not unpublish it.
--allowed-origins <origins> Comma-separated browser origins allowed to call
the gateway cross-origin (custom frontend
domains), e.g. https://app.example.com. The
tenant's own portal origin is always allowed.
--clear-allowed-origins Remove all custom allowed origins.
-h, --help display help for command
farthershore business publish
Usage: farthershore business publish [options] [businessIdOrName]
Publish a draft business (make it live) and cut a versioned release with an
auto-computed semver. Requires at least one plan, a bound backend, and a
verified Stripe connection.
Options:
--bump <bump> Force the semver bump (major|minor|patch). Omit to
auto-derive from the change.
--version <version> Pin the exact next release tag (vX.Y.Z), skipping
derivation.
--accept-breaking Consent to publish a breaking (blocking-risk) change
as a major release.
--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
Publish auto-derives the semver bump from the change and cuts a vX.Y.Z release.
Use --dry-run to preview the computed bump + reasons without cutting a tag.
A blocking-risk (breaking) change is refused unless --accept-breaking is passed.
farthershore business rollback
Usage: farthershore business rollback [options] [businessIdOrName] <workflowExecutionId>
Roll back a prior business publish workflow
Options:
--reason <reason> Reason recorded with the rollback
--idempotency-key <key> Required for this mutation. Generate it once and
reuse the exact value on retry.
-h, --help display help for command
farthershore business preview-env
Usage: farthershore business preview-env [options] [command]
Configure automatic preview environment creation for a business
Options:
-h, --help display help for command
Commands:
set [options] [businessIdOrName] Configure automatic preview-environment
creation for a business.
help [command] display help for command
farthershore business preview-env set
Usage: farthershore business preview-env set [options] [businessIdOrName]
Configure automatic preview-environment creation for a business.
Options:
--trigger <branch-prefix|pull-request|disabled> Auto-create previews from env branch prefixes, pull requests, or disable automatic creation.
--branch-prefix <prefix> Set the env branch prefix used by --trigger branch-prefix (1-50 characters).
--clear-branch-prefix Reset the env branch prefix to the platform default (env/).
-h, --help display help for command
farthershore business docs
Usage: farthershore business docs [options] [command]
Enable or disable docs publishing for a business
Options:
-h, --help display help for command
Commands:
enable [businessIdOrName] Enable docs for a business (publish/serve docs
scaffold).
disable [businessIdOrName] Disable docs for a business (stop
publishing/serving docs; scaffold kept in the
repo).
help [command] display help for command
farthershore business docs enable
Usage: farthershore business docs enable [options] [businessIdOrName]
Enable docs for a business (publish/serve docs scaffold).
Options:
-h, --help display help for command
farthershore business docs disable
Usage: farthershore business docs disable [options] [businessIdOrName]
Disable docs for a business (stop publishing/serving docs; scaffold kept in the
repo).
Options:
-h, --help display help for command