Example
Options
- NAME required
--examples--output-schema--json--refresh.
Exit status
0 on success; 2 when the command is unknown or on usage, configuration or request failure.What happens
Prints one definition from the catalog snapshot: name, toolset, tier, read or write, scopes, description, every parameter with type, bounds and whether it is required, aliases, and the admission note when the command is gated.--examples adds recorded example calls; --output-schema adds the output schema. A retired name resolves to its canonical command and says so. --refresh reads the live catalog instead, using REST for an API key or MCP for a saved OAuth connection.
Output is JSON when stdout is not a terminal or --json is given.
More examples
More examples
Full command syntax
Full command syntax
Configuration and file contracts
Configuration and file contracts
Read configuration and file ownership for environment variables, compatibility aliases and writer locks. Read local file contracts for artifact fields. Browse the CLI index for related commands.
Check the selected environment and workspace access before calling hosted operations. See capability status.