Generated from
@teamgrid/cli@1.0.6at Developer Platform commite6f6b47fa223. Runnode scripts/sync-cli-reference.mjs --checkto detect drift; do not edit this page manually.
read and manage documents.
Global options
Global options can be placed before the command group.
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
-V, --version |
output the version number | No | — | — |
-o, --output <format> |
output format | No | table, json, jsonl |
table |
--profile <name> |
credential profile | No | — | — |
--base-url <url> |
override the regional API v1 base URL | No | — | — |
--timeout <milliseconds> |
request timeout | No | — | 30000 |
--retries <count> |
safe-request retry count (0–5) | No | — | 2 |
Commands
teamgrid documents list— List document metadata.teamgrid documents create— Create a document.teamgrid documents get— Get a document.teamgrid documents update— Update a document.teamgrid documents archive— Archive a document.teamgrid documents restore— Restore a document.
teamgrid documents list
List document metadata.
Syntax
teamgrid documents list [options]API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
listDocuments |
GET /documents |
documents:read |
List document metadata |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
--all |
read every page | No | — | — |
--cursor <cursor> |
resume from an opaque cursor | No | — | — |
--limit <number> |
resources per page (1–100) | No | — | — |
--max-pages <number> |
safety limit for –all (1–10000) | No | — | 10000 |
--archived <boolean> |
return archived documents | No | — | — |
The global options and implicit -h, --help option also apply.
Output
Without --all, table output renders the page data and JSON preserves the complete page envelope. With --all, table and JSON aggregate all traversed resources while JSONL streams one resource per line.
Example
teamgrid documents listExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.
teamgrid documents create
Create a document.
Syntax
teamgrid documents create [options]API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
createDocument |
POST /documents |
documents:write |
Create a document |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
--data <json|@file|-> |
document create JSON | Yes | — | — |
--idempotency-key <key> |
stable retry key | No | — | — |
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Example
teamgrid documents create --data @request.jsonExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.
teamgrid documents get
Get a document.
Syntax
teamgrid documents get [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
getDocument |
GET /documents/{id} |
documents:read |
Get a document |
Arguments
| Argument | Required | Variadic | Choices | Default | Description |
|---|---|---|---|---|---|
id |
Yes | No | — | — | Identifier or value named by the command syntax. |
Command options
This command defines no additional options.
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Example
teamgrid documents get IDExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.
teamgrid documents update
Update a document.
Syntax
teamgrid documents update [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
updateDocument |
PATCH /documents/{id} |
documents:write |
Update a document |
Arguments
| Argument | Required | Variadic | Choices | Default | Description |
|---|---|---|---|---|---|
id |
Yes | No | — | — | Identifier or value named by the command syntax. |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
--data <json|@file|-> |
document update JSON | Yes | — | — |
--if-match <etag> |
latest strong document ETag | Yes | — | — |
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Example
teamgrid documents update ID --data @request.json --if-match ETAGExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.
teamgrid documents archive
Archive a document.
Syntax
teamgrid documents archive [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
archiveDocument |
DELETE /documents/{id} |
documents:write |
Archive a document |
Arguments
| Argument | Required | Variadic | Choices | Default | Description |
|---|---|---|---|---|---|
id |
Yes | No | — | — | Identifier or value named by the command syntax. |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
--if-match <etag> |
latest strong document ETag | Yes | — | — |
-y, --yes |
skip the destructive-operation confirmation | No | — | — |
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Confirmation and automation
This command can change or remove data and asks for confirmation by default. In a reviewed non-interactive job, pass --yes or set TEAMGRID_CLI_ASSUME_YES=1; otherwise the command exits with code 2. Cancelling an interactive confirmation exits with code 0.
Example
teamgrid documents archive ID --if-match ETAGExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.
teamgrid documents restore
Restore a document.
Syntax
teamgrid documents restore [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
restoreDocument |
POST /documents/{id}/restore |
documents:write |
Restore a document |
Arguments
| Argument | Required | Variadic | Choices | Default | Description |
|---|---|---|---|---|---|
id |
Yes | No | — | — | Identifier or value named by the command syntax. |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
--if-match <etag> |
latest strong document ETag | Yes | — | — |
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Example
teamgrid documents restore ID --if-match ETAGExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.