CLI: proposal

farthershore proposal#

Usage: farthershore proposal [options] [command]

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

Commands:
  create [options] [businessIdOrSlug] [subscriberId]                 Propose a governed ChangeSet against a subscriber (agent/builder proposer; a human approves + applies in the portal)
  preview [options] [businessIdOrSlug] [subscriberId] [changeSetId]  Simulate + store a preview on a proposed ChangeSet (rides the propose authority)
  list [options] [businessIdOrSlug] [subscriberId]                   List governed ChangeSets proposed against a subscriber
  get [options] [businessIdOrSlug] [subscriberId] [changeSetId]      Read one governed ChangeSet proposed against a subscriber
  help [command]                                                     display help for command

farthershore proposal create#

Usage: farthershore proposal create [options] [businessIdOrSlug] <subscriberId>

Propose a governed ChangeSet against a subscriber (agent/builder proposer; a
human approves + applies in the portal)

Options:
  --intent <intent>        Human-readable description of the proposed change.
  --operations <json>      JSON array of governed operations (e.g.
                           update_role_permissions).
  --env <env>              Environment name/id to scope the proposal to.
  --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 proposal preview#

Usage: farthershore proposal preview [options] [businessIdOrSlug] <subscriberId> <changeSetId>

Simulate + store a preview on a proposed ChangeSet (rides the propose authority)

Options:
  --env <env>  Environment name/id to scope the proposal to.
  -h, --help   display help for command

farthershore proposal list#

Usage: farthershore proposal list [options] [businessIdOrSlug] <subscriberId>

List governed ChangeSets proposed against a subscriber

Options:
  --status <status>  Filter by status (e.g. draft, approval_required).
  --env <env>        Environment name/id to scope the proposal to.
  -h, --help         display help for command

farthershore proposal get#

Usage: farthershore proposal get [options] [businessIdOrSlug] <subscriberId> <changeSetId>

Read one governed ChangeSet proposed against a subscriber

Options:
  --env <env>  Environment name/id to scope the proposal to.
  -h, --help   display help for command