CLI: variables

farthershore variables#

Usage: farthershore variables [options] [command]

Manage FS_PUBLIC_ bundle variables and write-only secrets (the name is the
class: FS_PUBLIC_ = public, everything else = secret)

Options:
  -h, --help                                  display help for command

Commands:
  list [options] [businessIdOrSlug]           List variables: FS_PUBLIC_* values, secret metadata only
  set [options] [businessIdOrSlug] [name]     Create a variable from stdin (secret unless named FS_PUBLIC_*)
  rotate [options] [businessIdOrSlug] [name]  Rotate a variable from stdin (the name, and so the class, is unchanged)
  revoke [options] [businessIdOrSlug] [name]  Revoke runtime access to a secret. Requires --yes.
  rm [options] [businessIdOrSlug] [name]      Destroy a revoked secret in Main or preview. Requires --yes.
  status [businessIdOrSlug] [operationId]     Read a durable secret mutation operation
  help [command]                              display help for command

farthershore variables list#

Usage: farthershore variables list [options] [businessIdOrSlug]

List variables: FS_PUBLIC_* values, secret metadata only

Options:
  --env <slug>  Preview environment slug or id (omit for Main).
  -h, --help    display help for command

farthershore variables set#

Usage: farthershore variables set [options] [businessIdOrSlug] <name>

Create a variable from stdin (secret unless named FS_PUBLIC_*)

Options:
  --env <slug>             Preview environment slug or id (omit for Main).
  --idempotency-key <key>  Required for this mutation. Generate it once and
                           reuse the exact value on retry.
  -h, --help               display help for command

Example:
  printf %s "$VALUE" | farthershore variables set my-biz POSTHOG_TOKEN

farthershore variables rotate#

Usage: farthershore variables rotate [options] [businessIdOrSlug] <name>

Rotate a variable from stdin (the name, and so the class, is unchanged)

Options:
  --env <slug>             Preview environment slug or id (omit for Main).
  --idempotency-key <key>  Required for this mutation. Generate it once and
                           reuse the exact value on retry.
  -h, --help               display help for command

Example:
  printf %s "$VALUE" | farthershore variables rotate my-biz POSTHOG_TOKEN

farthershore variables revoke#

Usage: farthershore variables revoke [options] [businessIdOrSlug] <name>

Revoke runtime access to a secret. Requires --yes.

Options:
  --env <slug>             Preview environment slug or id (omit for Main).
  --yes                    Skip confirmation; required for this destructive
                           action
  --idempotency-key <key>  Required for this mutation. Generate it once and
                           reuse the exact value on retry.
  -h, --help               display help for command

farthershore variables rm#

Usage: farthershore variables rm [options] [businessIdOrSlug] <name>

Destroy a revoked secret in Main or preview. Requires --yes.

Options:
  --env <slug>             Preview environment slug or id (omit for Main).
  --yes                    Skip confirmation; required for this destructive
                           action
  --idempotency-key <key>  Required for this mutation. Generate it once and
                           reuse the exact value on retry.
  -h, --help               display help for command

farthershore variables status#

Usage: farthershore variables status [options] [businessIdOrSlug] <operationId>

Read a durable secret mutation operation

Options:
  -h, --help  display help for command