gcai playbooks CLI commands

`gcai playbooks list`

List playbooks

gcai playbooks list [--limit <number>] [--offset <number>]

Flag	Type	Required	Description
`--limit <number>`	`number`		Max items to return (default 100, max 500)
`--offset <number>`	`number`		Number of items to skip (default 0)

Wraps GET /playbooks — see List playbooks for full parameter semantics.

`gcai playbooks get`

Get a playbook

gcai playbooks get <id>

Wraps GET /playbooks/{id} — see Get a playbook for full parameter semantics.

`gcai playbooks create`

Create a playbook

gcai playbooks create <title> [--description <value>] [--guide <value>]

Flag	Type	Required	Description
`--description <value>`	`string`		Optional human-facing description.
`--guide <value>`	`string`		Optional free-text guidance applied across the whole playbook when it runs.

Wraps POST /playbooks — see Create a playbook for full parameter semantics.

`gcai playbooks update`

Update a playbook

gcai playbooks update <id> [--title <value>] [--description <value>] [--guide <value>]

Flag	Type	Description
`--title <value>`	`string`	New title (non-empty).
`--description <value>`	`string`	New description, or null to clear.
`--guide <value>`	`string`	New guide text, or null to clear.

Wraps PATCH /playbooks/{id} — see Update a playbook for full parameter semantics.

`gcai playbooks duplicate`

Duplicate a playbook

gcai playbooks duplicate <id>

Wraps POST /playbooks/{id}/duplicate — see Duplicate a playbook for full parameter semantics.

`gcai playbooks delete`

Delete a playbook

gcai playbooks delete <id>

Wraps DELETE /playbooks/{id} — see Delete a playbook for full parameter semantics.

`gcai playbooks run`

Run a playbook against uploaded files

gcai playbooks run <id> --file-ids <value>… [--review-mode <first-party|third-party>] [--representing-party <value>] [--check-ids <value>…] [--company-id <value>] [--async] [--timeout <seconds>]

Flag	Type	Required	Description
`--file-ids <value>…`	`string[]`	yes	IDs of uploaded files to review. Files must be in `ready` status. At least one file is required.
`--review-mode <first-party\|third-party>`	`first-party \| third-party`		Whose perspective the review takes. `third-party` reviews a counterparty document (default); `first-party` reviews your own.
`--representing-party <value>`	`string`		Name of the party the review represents (default: “our company”).
`--check-ids <value>…`	`string[]`		Optional subset of check IDs to evaluate. Omit to run every check in the playbook.
`--company-id <value>`	`string`		Optional company profile to ground the review in, so the checks have that company’s context (industry, jurisdiction, regulations, risk posture). Discover company profiles via `GET /company-profiles`. Opt-in: supply this to ground the review against a specific company. When omitted, the review runs with no company profile. This is separate from `representing_party`, which stays free text.
`--async`	`boolean`		Return the pending job immediately instead of waiting.
`--timeout <seconds>`	`number`		Client-side wait bound before giving up (default 300).

Wraps POST /playbooks/{id}/run — see Run a playbook against uploaded files for full parameter semantics.

`gcai playbooks checks list`

List a playbook’s checks

gcai playbooks checks list <id>

Wraps GET /playbooks/{id}/checks — see List a playbook’s checks for full parameter semantics.

`gcai playbooks checks get`

Get a check

gcai playbooks checks get <id> <checkId>

Wraps GET /playbooks/{id}/checks/{checkId} — see Get a check for full parameter semantics.

`gcai playbooks checks create`

Add a check to a playbook

gcai playbooks checks create <id> <title> [--description <value>] [--importance <low|medium|high>] --positions <json>…

Flag	Type	Required	Description
`--description <value>`	`string`		Optional internal description.
`--importance <low\|medium\|high>`	`low \| medium \| high`		Optional priority within the playbook.
`--positions <json>…`	`object[]`	yes	The check’s positions: exactly one `standard` position plus any number of `fallback` positions.

Wraps POST /playbooks/{id}/checks — see Add a check to a playbook for full parameter semantics.

`gcai playbooks checks update`

Update a check

gcai playbooks checks update <id> <checkId> [--title <value>] [--description <value>] [--importance <low|medium|high>] [--positions <json>…]

Flag	Type	Description
`--title <value>`	`string`	New title (non-empty).
`--description <value>`	`string`	New description, or null to clear.
`--importance <low\|medium\|high>`	`low \| medium \| high`	New priority, or null to clear.
`--positions <json>…`	`object[]`	Replacement set of positions (full desired state). Omit to leave positions unchanged.

Wraps PATCH /playbooks/{id}/checks/{checkId} — see Update a check for full parameter semantics.

`gcai playbooks checks delete`

Remove a check from a playbook

gcai playbooks checks delete <id> <checkId>

Wraps DELETE /playbooks/{id}/checks/{checkId} — see Remove a check from a playbook for full parameter semantics.

`gcai playbooks checks reorder`

Reorder a playbook’s checks

gcai playbooks checks reorder <id> --check-ids <value>…

Flag	Type	Required	Description
`--check-ids <value>…`	`string[]`	yes	All check IDs of the playbook in the desired order. Checks omitted from the list keep their existing order relative to one another.

Wraps POST /playbooks/{id}/checks/reorder — see Reorder a playbook’s checks for full parameter semantics.

REST

MCP

CLI

gcai playbooks CLI commands

`gcai playbooks list`

`gcai playbooks get`

`gcai playbooks create`

`gcai playbooks update`

`gcai playbooks duplicate`

`gcai playbooks delete`

`gcai playbooks run`

`gcai playbooks checks list`

`gcai playbooks checks get`

`gcai playbooks checks create`

`gcai playbooks checks update`

`gcai playbooks checks delete`

`gcai playbooks checks reorder`

​gcai playbooks list

​gcai playbooks get

​gcai playbooks create

​gcai playbooks update

​gcai playbooks duplicate

​gcai playbooks delete

​gcai playbooks run

​gcai playbooks checks list

​gcai playbooks checks get

​gcai playbooks checks create

​gcai playbooks checks update

​gcai playbooks checks delete

​gcai playbooks checks reorder

`gcai playbooks list`

`gcai playbooks get`

`gcai playbooks create`

`gcai playbooks update`

`gcai playbooks duplicate`

`gcai playbooks delete`

`gcai playbooks run`

`gcai playbooks checks list`

`gcai playbooks checks get`

`gcai playbooks checks create`

`gcai playbooks checks update`

`gcai playbooks checks delete`

`gcai playbooks checks reorder`