Planned command groups for tradeics. Names are stable enough to document against; flags may grow. Treat anything marked planned as subject to polish before GA.
Global flags
| Flag | Purpose |
|---|---|
--profile <name> |
Select a named config profile |
--api-key <key> |
Override auth for this invocation |
--base-url <url> |
Override REST base (default https://api.tradeics.example/v2) |
--format <table|json|yaml> |
Output format |
--verbose / -v |
Log HTTP method, path, status, latency |
--no-color |
Disable ANSI styling |
Core
| Command | Purpose |
|---|---|
tradeics version |
Print CLI version and build metadata |
tradeics doctor |
Connectivity + auth + TLS diagnostics |
tradeics help [command] |
Nested help |
tradeics completion bash|zsh|fish|powershell |
Shell autocompletion |
Auth & config
| Command | Purpose |
|---|---|
tradeics login |
Interactive credential capture |
tradeics logout |
Clear profile session / key |
tradeics auth status |
Show active principal (masked) |
tradeics config set|get|list |
Manage profiles and defaults |
REST (api)
Thin, scriptable wrapper over REST API V2.
tradeics api get <path> [--query k=v]
tradeics api post <path> --body '{"...":...}' | --file payload.json
tradeics api put <path> --body ...
tradeics api patch <path> --body ...
tradeics api delete <path>Convenience aliases (planned as resources expand):
tradeics master vendor-sub-categories list
tradeics b2b rfqs list --status open
tradeics finance payments get <payment_id>LLM (llm)
Talk to https://llm.tradeics.example without hand-rolling HTTP.
tradeics llm models list
tradeics llm chat --model <id> --message "Summarize this RFQ..."
tradeics llm embed --model <id> --input "catalog line..."
tradeics llm healthSee Call the LLM and LLM API Reference.
Webhooks (listen / trigger) — planned
tradeics listen --forward-to https://hooks.example.com/hooks/tradeics
tradeics trigger payment.captured --fixture fixtures/payment.jsonMirrors common CLI patterns (Stripe listen / trigger) for receiver development against a public HTTPS endpoint.
Docs & agents (docs)
tradeics docs open # opens https://developers.tradeics.com
tradeics docs llms # prints /llms.txt URL or contents
tradeics docs agent-prompt [--page…] # copy-ready prompt for Cursor / ClaudeMCP helpers — planned
tradeics mcp url # https://api.tradeics.example/mcp/
tradeics mcp doctor # probe Streamable HTTP + tools listExit codes
| Code | Meaning |
|---|---|
0 |
Success |
1 |
Usage / validation error |
2 |
Authentication failure |
3 |
API / HTTP error (non-2xx) |
4 |
Network / timeout |
5 |
Unexpected CLI failure |