# `cgd` command reference
> Generated from the compiled Clap command tree. Do not edit this file by hand.
This reference describes the command surface in the current alpha release.
## `cgd`
```text
The official Coragrid CLI. Explicit commands are deterministic and headless; stdout is data and stderr is diagnostics.
Usage: cgd [OPTIONS] [COMMAND]
Commands:
auth Inspect private-alpha authentication
config Inspect effective non-secret configuration
resolve Resolve a name, domain, external identifier, or Coragrid company ID
companies Search and retrieve canonical companies
documents Inspect rights-qualified source document metadata
tui Launch the interactive Coragrid terminal interface
completions Generate deterministic shell completions
version Print detailed client version information
Options:
--profile <PROFILE>
Select a local configuration profile
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--json
Convenience alias for --output json
--no-color
Disable ANSI color output
--quiet
Print the primary identifier only where supported
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--no-pager
Disable paging of human output. Paging is currently off by default
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
```
## `cgd auth`
```text
Inspect private-alpha authentication
Usage: cgd auth [OPTIONS] <COMMAND>
Commands:
login Interactively verify and store a private-alpha API key
logout Remove the selected profile's local credential binding
status Verify the configured credential and show safe caller capabilities
Options:
--profile <PROFILE>
Select a local configuration profile
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--json
Convenience alias for --output json
--no-color
Disable ANSI color output
--quiet
Print the primary identifier only where supported
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--no-pager
Disable paging of human output. Paging is currently off by default
-h, --help
Print help
```
## `cgd auth login`
```text
Interactively verify and store a private-alpha API key
Usage: cgd auth login [OPTIONS]
Options:
--profile <PROFILE>
Select a local configuration profile
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--json
Convenience alias for --output json
--no-color
Disable ANSI color output
--quiet
Print the primary identifier only where supported
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--no-pager
Disable paging of human output. Paging is currently off by default
-h, --help
Print help
```
## `cgd auth logout`
```text
Remove the selected profile's local credential binding
Usage: cgd auth logout [OPTIONS]
Options:
--profile <PROFILE>
Select a local configuration profile
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--json
Convenience alias for --output json
--no-color
Disable ANSI color output
--quiet
Print the primary identifier only where supported
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--no-pager
Disable paging of human output. Paging is currently off by default
-h, --help
Print help
```
## `cgd auth status`
```text
Verify the configured credential and show safe caller capabilities
Usage: cgd auth status [OPTIONS]
Options:
--profile <PROFILE>
Select a local configuration profile
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--json
Convenience alias for --output json
--no-color
Disable ANSI color output
--quiet
Print the primary identifier only where supported
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--no-pager
Disable paging of human output. Paging is currently off by default
-h, --help
Print help
```
## `cgd config`
```text
Inspect effective non-secret configuration
Usage: cgd config [OPTIONS] <COMMAND>
Commands:
list Print all effective non-secret settings
get Print one effective non-secret setting
set Set one validated value on the selected profile
profiles List configured profiles without exposing credentials
use Select an existing profile as the default
Options:
--profile <PROFILE>
Select a local configuration profile
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--json
Convenience alias for --output json
--no-color
Disable ANSI color output
--quiet
Print the primary identifier only where supported
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--no-pager
Disable paging of human output. Paging is currently off by default
-h, --help
Print help
```
## `cgd config list`
```text
Print all effective non-secret settings
Usage: cgd config list [OPTIONS]
Options:
--profile <PROFILE>
Select a local configuration profile
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--json
Convenience alias for --output json
--no-color
Disable ANSI color output
--quiet
Print the primary identifier only where supported
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--no-pager
Disable paging of human output. Paging is currently off by default
-h, --help
Print help
```
## `cgd config get`
```text
Print one effective non-secret setting
Usage: cgd config get [OPTIONS] <KEY>
Arguments:
<KEY>
[possible values: profile, api-base-url, workspace, output, timeout, no-color, credential-source, credential-ref, config-path]
Options:
--profile <PROFILE>
Select a local configuration profile
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--json
Convenience alias for --output json
--no-color
Disable ANSI color output
--quiet
Print the primary identifier only where supported
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--no-pager
Disable paging of human output. Paging is currently off by default
-h, --help
Print help
```
## `cgd config set`
```text
Set one validated value on the selected profile
Usage: cgd config set [OPTIONS] <KEY> <VALUE>
Arguments:
<KEY>
[possible values: api-base-url, workspace, output, timeout, no-color]
<VALUE>
Options:
--profile <PROFILE>
Select a local configuration profile
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--json
Convenience alias for --output json
--no-color
Disable ANSI color output
--quiet
Print the primary identifier only where supported
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--no-pager
Disable paging of human output. Paging is currently off by default
-h, --help
Print help
```
## `cgd config profiles`
```text
List configured profiles without exposing credentials
Usage: cgd config profiles [OPTIONS]
Options:
--profile <PROFILE>
Select a local configuration profile
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--json
Convenience alias for --output json
--no-color
Disable ANSI color output
--quiet
Print the primary identifier only where supported
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--no-pager
Disable paging of human output. Paging is currently off by default
-h, --help
Print help
```
## `cgd config use`
```text
Select an existing profile as the default
Usage: cgd config use [OPTIONS] <PROFILE>
Arguments:
<PROFILE>
Options:
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--json
Convenience alias for --output json
--no-color
Disable ANSI color output
--quiet
Print the primary identifier only where supported
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--no-pager
Disable paging of human output. Paging is currently off by default
-h, --help
Print help
```
## `cgd resolve`
```text
Resolve a name, domain, external identifier, or Coragrid company ID
Usage: cgd resolve [OPTIONS] <QUERY>
Arguments:
<QUERY>
Company name, domain, or permanent co_ identifier
Options:
--country <ISO2>
ISO 3166-1 alpha-2 jurisdiction hint
--profile <PROFILE>
Select a local configuration profile
--domain <DOMAIN>
Canonical company domain hint
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--identifier <SCHEME:VALUE>
Strong external selector in scheme:value form. One is supported in alpha
--json
Convenience alias for --output json
--limit <LIMIT>
Maximum candidates returned
[default: 5]
--no-color
Disable ANSI color output
--quiet
Print the primary identifier only where supported
--require-unique
Exit with code 5 unless exactly one company resolves
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--no-pager
Disable paging of human output. Paging is currently off by default
-h, --help
Print help
```
## `cgd companies`
```text
Search and retrieve canonical companies
Usage: cgd companies [OPTIONS] <COMMAND>
Commands:
search Search canonical company profiles
get Get one canonical company by permanent co_ identifier
officers List current source-attributed officers for a canonical company
Options:
--profile <PROFILE>
Select a local configuration profile
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--json
Convenience alias for --output json
--no-color
Disable ANSI color output
--quiet
Print the primary identifier only where supported
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--no-pager
Disable paging of human output. Paging is currently off by default
-h, --help
Print help
```
## `cgd companies search`
```text
Search canonical company profiles
Usage: cgd companies search [OPTIONS]
Options:
--profile <PROFILE>
Select a local configuration profile
--query <QUERY>
Semantic company thesis. Omit only when structured filters are present
--country <ISO2>
ISO 3166-1 alpha-2 country filter
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--json
Convenience alias for --output json
--status <STATUS>
Canonical company status filter
--no-color
Disable ANSI color output
--type <COMPANY_TYPE>
Canonical company type filter
--limit <LIMIT>
Page size, bounded by caller entitlement
[default: 25]
--quiet
Print the primary identifier only where supported
--cursor <CURSOR>
Opaque continuation cursor returned by Coragrid
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--all
Follow all pages up to --max-results
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--max-results <N>
Required safety bound when --all is used
--financial-field <FINANCIAL_FIELD>
Financial field used for a structured range. Currently revenue
[possible values: revenue]
--no-pager
Disable paging of human output. Paging is currently off by default
--financial-period <FINANCIAL_PERIOD>
Fiscal period in FYYYYY form, for example FY2025
--financial-currency <FINANCIAL_CURRENCY>
ISO 4217 currency for the financial filter
--financial-gte <FINANCIAL_GTE>
Inclusive lower financial bound in minor-independent whole units
--financial-lte <FINANCIAL_LTE>
Inclusive upper financial bound in minor-independent whole units
--financial-scope <FINANCIAL_SCOPE>
Reporting scope for the financial filter
[default: company]
[possible values: company, group]
-h, --help
Print help
```
## `cgd companies get`
```text
Get one canonical company by permanent co_ identifier
Usage: cgd companies get [OPTIONS] <COMPANY_ID>
Arguments:
<COMPANY_ID>
Permanent Coragrid company ID
Options:
--profile <PROFILE>
Select a local configuration profile
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--json
Convenience alias for --output json
--no-color
Disable ANSI color output
--quiet
Print the primary identifier only where supported
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--no-pager
Disable paging of human output. Paging is currently off by default
-h, --help
Print help
```
## `cgd companies officers`
```text
List current source-attributed officers for a canonical company
Usage: cgd companies officers [OPTIONS] <COMPANY_ID>
Arguments:
<COMPANY_ID>
Permanent Coragrid company ID
Options:
--limit <LIMIT>
Maximum current officer records to return
[default: 100]
--profile <PROFILE>
Select a local configuration profile
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--json
Convenience alias for --output json
--no-color
Disable ANSI color output
--quiet
Print the primary identifier only where supported
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--no-pager
Disable paging of human output. Paging is currently off by default
-h, --help
Print help
```
## `cgd documents`
```text
Inspect rights-qualified source document metadata
Usage: cgd documents [OPTIONS] <COMMAND>
Commands:
get Get metadata for one permanent Coragrid document ID
Options:
--profile <PROFILE>
Select a local configuration profile
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--json
Convenience alias for --output json
--no-color
Disable ANSI color output
--quiet
Print the primary identifier only where supported
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--no-pager
Disable paging of human output. Paging is currently off by default
-h, --help
Print help
```
## `cgd documents get`
```text
Get metadata for one permanent Coragrid document ID
Usage: cgd documents get [OPTIONS] --metadata <DOCUMENT_ID>
Arguments:
<DOCUMENT_ID>
Permanent Coragrid document ID
Options:
--metadata
Retrieve metadata only. Document bytes are not available in this release
--profile <PROFILE>
Select a local configuration profile
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--json
Convenience alias for --output json
--no-color
Disable ANSI color output
--quiet
Print the primary identifier only where supported
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--no-pager
Disable paging of human output. Paging is currently off by default
-h, --help
Print help
```
## `cgd tui`
```text
Launch the interactive Coragrid terminal interface
Usage: cgd tui [OPTIONS]
Options:
--no-mouse
Disable mouse capture while the terminal interface is active
--profile <PROFILE>
Select a local configuration profile
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--theme <THEME>
Select a terminal theme
[default: dark]
[possible values: dark, light, mono]
--json
Convenience alias for --output json
--no-color
Disable ANSI color output
--quiet
Print the primary identifier only where supported
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--no-pager
Disable paging of human output. Paging is currently off by default
-h, --help
Print help
```
## `cgd completions`
```text
Generate deterministic shell completions
Usage: cgd completions [OPTIONS] <SHELL>
Arguments:
<SHELL>
Shell whose completion script should be generated
[possible values: bash, elvish, fish, powershell, zsh]
Options:
--profile <PROFILE>
Select a local configuration profile
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--json
Convenience alias for --output json
--no-color
Disable ANSI color output
--quiet
Print the primary identifier only where supported
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--no-pager
Disable paging of human output. Paging is currently off by default
-h, --help
Print help
```
## `cgd version`
```text
Print detailed client version information
Usage: cgd version [OPTIONS]
Options:
--profile <PROFILE>
Select a local configuration profile
--output <OUTPUT>
Select the output representation
[possible values: table, json, jsonl, csv]
--json
Convenience alias for --output json
--no-color
Disable ANSI color output
--quiet
Print the primary identifier only where supported
-v, --verbose...
Increase diagnostic detail without exposing credentials or response bodies
--timeout <TIMEOUT>
Bound the complete request, such as 500ms, 10s, or 2m
--api-base-url <URL>
Override the API endpoint. Remote endpoints must use HTTPS
--no-pager
Disable paging of human output. Paging is currently off by default
-h, --help
Print help
```