Command reference
deployments brain
Governed company and member-private knowledge Brains
| Command | Summary |
|---|---|
deployments brain search | Search source-grounded Brain evidence |
deployments brain ask | Ask a cited question across authorized Brains |
deployments brain list | List visible Brains |
deployments brain create | Create a Brain |
deployments brain show | Show a Brain |
deployments brain index-health | List Brain document index health |
deployments brain update | Update a Brain |
deployments brain archive | Archive a Brain |
deployments brain search
Search source-grounded Brain evidence.
deployments brain search --brains <a-b-c> --query <query>- Calls
POST /v1/brains/search(SDKsearchBrains). - Needs an organization, project, and environment:
--org,--project,--env, or the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--brains | string (a,b,c) | yes | Brain IDs | |
--limit | string (number) | Maximum evidence results | ||
--query | string | yes | Evidence query |
Also accepts the global flags.
deployments brain ask
Ask a cited question across authorized Brains.
deployments brain ask --brains <a-b-c> --question <question>- Calls
POST /v1/brains/ask(SDKaskBrains). - Needs an organization, project, and environment:
--org,--project,--env, or the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--brains | string (a,b,c) | yes | Brain IDs | |
--evidence-limit | string (number) | Maximum evidence results | ||
--question | string | yes | Question |
Also accepts the global flags.
deployments brain list
List visible Brains.
deployments brain list- Calls
GET /v1/brains(SDKlistBrains). - Needs an organization:
--orgor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size | ||
--status | string | Brain status |
Also accepts the global flags.
deployments brain create
Create a Brain.
deployments brain create --kind <kind> --name <name> --slug <slug>- Calls
POST /v1/brains(SDKcreateBrain). - Needs an organization:
--orgor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--kind | string | yes | Brain kind: company or member-private | |
--name | string | yes | Brain name | |
--sensitivity | string | Default sensitivity | ||
--slug | string | yes | Organization-unique Brain slug |
Also accepts the global flags.
deployments brain show
Show a Brain.
deployments brain show <brain>- Calls
GET /v1/brains/{brainId}(SDKgetBrain). - Needs an organization:
--orgor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<brain> | positional | yes | Brain ID |
Also accepts the global flags.
deployments brain index-health
List Brain document index health.
deployments brain index-health <brain>- Calls
GET /v1/brains/{brainId}/index-health(SDKlistBrainIndexHealth). - Needs an organization:
--orgor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size | ||
<brain> | positional | yes | Brain ID |
Also accepts the global flags.
deployments brain update
Update a Brain.
deployments brain update <brain> --expected-version <number>- Calls
PATCH /v1/brains/{brainId}(SDKupdateBrain). - Needs an organization:
--orgor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<brain> | positional | yes | Brain ID | |
--expected-version | string (number) | yes | Current Brain version | |
--maintenance-policy | string (json) | Maintenance policy | ||
--name | string | Brain name | ||
--retrieval-policy | string (json) | Retrieval policy | ||
--sensitivity | string | Default sensitivity | ||
--slug | string | Organization-unique Brain slug |
Also accepts the global flags.
deployments brain archive
Archive a Brain.
deployments brain archive <brain> --expected-version <number>- Calls
DELETE /v1/brains/{brainId}(SDKarchiveBrain). - Needs an organization:
--orgor the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<brain> | positional | yes | Brain ID | |
--expected-version | string (number) | yes | Current Brain version |
Also accepts the global flags.