> ## Documentation Index > Fetch the complete documentation index at: https://docs.gc.ai/llms.txt > Use this file to discover all available pages before exploring further. # gcai playbooks CLI commands > Reference for the `gcai playbooks` commands in the GC AI CLI, with the synopsis and flags for each command. ## `gcai playbooks list` List playbooks ```bash theme={null} gcai playbooks list [--limit ] [--offset ] ``` | Flag | Type | Required | Description | | - | - | - | - | | `--limit ` | `number` | | Max items to return (default 100, max 500) | | `--offset ` | `number` | | Number of items to skip (default 0) | Wraps `GET /playbooks` — see [List playbooks](/api-reference/list-playbooks) for full parameter semantics. ## `gcai playbooks get` Get a playbook ```bash theme={null} gcai playbooks get ``` Wraps `GET /playbooks/{id}` — see [Get a playbook](/api-reference/get-playbook) for full parameter semantics. ## `gcai playbooks create` Create a playbook ```bash theme={null} gcai playbooks create [--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](/api-reference/create-playbook) for full parameter semantics. ## `gcai playbooks update` Update a playbook ```bash theme={null} gcai playbooks update <id> [--title <value>] [--description <value>] [--guide <value>] ``` | Flag | Type | Required | 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](/api-reference/update-playbook) for full parameter semantics. ## `gcai playbooks duplicate` Duplicate a playbook ```bash theme={null} gcai playbooks duplicate <id> ``` Wraps `POST /playbooks/{id}/duplicate` — see [Duplicate a playbook](/api-reference/duplicate-playbook) for full parameter semantics. ## `gcai playbooks delete` Delete a playbook ```bash theme={null} gcai playbooks delete <id> ``` Wraps `DELETE /playbooks/{id}` — see [Delete a playbook](/api-reference/delete-playbook) for full parameter semantics. ## `gcai playbooks run` Run a playbook against uploaded files ```bash theme={null} 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](/api-reference/run-playbook) for full parameter semantics. ## `gcai playbooks checks list` List a playbook's checks ```bash theme={null} gcai playbooks checks list <id> ``` Wraps `GET /playbooks/{id}/checks` — see [List a playbook's checks](/api-reference/list-playbook-checks) for full parameter semantics. ## `gcai playbooks checks get` Get a check ```bash theme={null} gcai playbooks checks get <id> <checkId> ``` Wraps `GET /playbooks/{id}/checks/{checkId}` — see [Get a check](/api-reference/get-playbook-check) for full parameter semantics. ## `gcai playbooks checks create` Add a check to a playbook ```bash theme={null} 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](/api-reference/create-playbook-check) for full parameter semantics. ## `gcai playbooks checks update` Update a check ```bash theme={null} gcai playbooks checks update <id> <checkId> [--title <value>] [--description <value>] [--importance <low|medium|high>] [--positions <json>…] ``` | Flag | Type | Required | 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](/api-reference/update-playbook-check) for full parameter semantics. ## `gcai playbooks checks delete` Remove a check from a playbook ```bash theme={null} gcai playbooks checks delete <id> <checkId> ``` Wraps `DELETE /playbooks/{id}/checks/{checkId}` — see [Remove a check from a playbook](/api-reference/delete-playbook-check) for full parameter semantics. ## `gcai playbooks checks reorder` Reorder a playbook's checks ```bash theme={null} 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](/api-reference/reorder-playbook-checks) for full parameter semantics. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.