@cloudyali/cli

Command-line client for the CloudYali public API — FinOps cost visibility and management across AWS, Azure and GCP.

npx @cloudyali/cli features --provider AWS

No authentication, no configuration, no dependencies. Every command prints JSON on stdout, so it composes with jq:

cloudyali features | jq '.features[] | {id, name}'
cloudyali blogs --limit 5 | jq '.posts[].title'
cloudyali blog aws-backup-cold-tier | jq -r '.body_markdown'

Install

npm install -g @cloudyali/cli   # or: npx @cloudyali/cli <command>

Requires Node 20 or newer, for the global fetch.

Commands

| Command | What it does | |---|---| | cloudyali health | Check the API is reachable | | cloudyali api | Print the discovery document | | cloudyali features [--id <id>] [--provider <name>] | List product capabilities | | cloudyali blogs [--limit <n>] [--offset <n>] [--category <slug>] | List blog posts | | cloudyali blog <slug> | One post, body included, as Markdown | | cloudyali openapi | The OpenAPI 3.1 specification | | cloudyali catalog | The RFC 9727 API catalog |

Global options: --json prints the raw { success, data } envelope instead of just the data; --base-url <url> points at a different deployment.

Exit codes

| Code | Meaning | |---|---| | 0 | Success | | 1 | Usage error, unknown command, or an API error | | 2 | Rate limited — the message carries the Retry-After value |

Rate limits and versioning

The public API allows 120 requests per minute per client and announces deprecations with the Deprecation and Sunset headers. See the rate-limit reference and the versioning policy.

Development

The source lives in the cli/ directory of the CloudYali website repository. Its tests run as part of the website's vitest suite (npm run test:run at the repository root).

To publish:

cd cli && npm publish --access public

Licence

MIT