This reference is generated from the real @teamgrid/cli@1.0.6 Commander tree and the public API capability manifest. It covers all 216 executable commands in 52 top-level groups, including 143 argument and 520 command-option definitions plus 6 global options. Its 210 canonical CLI paths map to all 211 API v1 operations.
Use CLI commands for workflow-oriented guidance and this reference when you need exact terminal syntax. Run teamgrid --version before comparing an installed CLI with this release.
Global options
| 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 |
Every command also accepts the implicit -h, --help option. Global options are inherited by subcommands and can be placed before the top-level command group.
Input, output, and safety conventions
--data <json|@file|->accepts inline JSON, a file prefixed with@, or standard input with-.--output tableis intended for people. Usejsonorjsonlfor automation.- Commands carrying
--alltraverse opaque cursor pages, bounded by--max-pages. --if-matchalways requires the latest server-issued revision or strong ETag; never synthesize it.- Commands carrying
--yesask before destructive or complete-replacement behavior. Non-interactive sessions must opt in explicitly. - Reveal-once credentials, webhook secrets, and raw export downloads use dedicated file/stdout options so structured output cannot accidentally mix with secret or binary bytes.
See CLI automation for pagination and exit-code handling and CLI maintenance and troubleshooting for upgrades, shell behavior, private CAs, debugging, and common failures.
Command groups
| Command group | Executable commands | Description |
|---|---|---|
teamgrid doctor |
1 | run read-only configuration, credential, routing, network, and API checks. |
teamgrid auth |
4 | manage local credential profiles. |
teamgrid api-version |
1 | discover the TeamGrid API version. |
teamgrid workspace |
2 | inspect the authenticated workspace. |
teamgrid system |
1 | inspect API and product capabilities. |
teamgrid workspace-settings |
2 | read and update public workspace settings. |
teamgrid credentials |
4 | manage native API v1 credentials. |
teamgrid service-accounts |
10 | manage service-account principals and credentials. |
teamgrid events |
1 | inspect scoped public events. |
teamgrid projects |
10 | read and mutate projects. |
teamgrid project-lifecycle-operations |
1 | inspect asynchronous project lifecycle operations. |
teamgrid products |
5 | read and manage products. |
teamgrid product-groups |
5 | read and manage product-groups. |
teamgrid project-statements |
6 | read and manage project-statements. |
teamgrid tasks |
14 | read and mutate tasks. |
teamgrid time-entries |
8 | read and mutate time entries. |
teamgrid call-notes |
5 | read and manage call notes. |
teamgrid contacts |
4 | read and mutate contacts. |
teamgrid contact-groups |
6 | read and manage contact groups. |
teamgrid users |
1 | list workspace users. |
teamgrid lists |
7 | read and manage lists. |
teamgrid services |
7 | read and manage services. |
teamgrid tags |
7 | read and manage tags. |
teamgrid custom-field-definitions |
6 | read and manage custom-field definitions. |
teamgrid custom-field-values |
4 | read and compare-and-set custom-field values. |
teamgrid project-templates |
7 | read and manage reusable project templates. |
teamgrid project-template-instantiations |
1 | inspect credential-owned project-template instantiations. |
teamgrid planned-work |
3 | read and atomically replace task planned work. |
teamgrid planned-work-operations |
1 | inspect credential-owned planned-work replacements. |
teamgrid changes |
2 | create checkpoints and read the cell-local change feed. |
teamgrid audit-events |
1 | list Developer Platform audit events. |
teamgrid webhook-deliveries |
2 | inspect credential-owned webhook delivery history. |
teamgrid appointments |
6 | read and manage appointments. |
teamgrid absences |
6 | read and manage absences. |
teamgrid availability |
1 | inspect derived availability. |
teamgrid activity |
1 | inspect target-owned activity. |
teamgrid comments |
5 | read and manage target comments. |
teamgrid documents |
6 | read and manage documents. |
teamgrid files |
6 | read and manage file metadata. |
teamgrid file-upload-intents |
3 | create and complete direct file uploads. |
teamgrid members |
4 | read and administer workspace members. |
teamgrid invitations |
5 | read and administer workspace invitations. |
teamgrid roles |
5 | read and administer workspace roles. |
teamgrid groups |
5 | read and administer workspace groups. |
teamgrid search |
1 | search permitted TeamGrid resources. |
teamgrid exports |
4 | create and download bounded exports. |
teamgrid automation-actions |
1 | inspect the public automation action catalog. |
teamgrid automation-definitions |
6 | read and administer automation definitions. |
teamgrid automation-definition-versions |
1 | inspect immutable automation definition versions. |
teamgrid automation-runs |
3 | inspect and control automation runs. |
teamgrid integration-installations |
1 | inspect redacted integration installation metadata. |
teamgrid webhooks |
7 | read and manage webhooks. |
Synchronization contract
The checked-in source is sources/cli-reference.json. The synchronization script verifies the pinned Developer Platform commit from sources/packages.json, rebuilds the API client and CLI locally, extracts the Commander tree, joins it to developer-capabilities.json, and rewrites this index plus one page per top-level group. Check mode performs the same derivation without changing files and fails on any source or generated-page drift.