Skip to main content

CloudYali CLI

cloudyali is a zero-dependency command-line client for the CloudYali public API. It needs no account and no configuration, and every command prints JSON on stdout — so it drops straight into a shell pipeline, a Makefile or an agent’s tool loop without anyone writing an HTTP client first.

Installing the CloudYali CLI

# one-off
npx @cloudyali/cli features

# or install it
npm install -g @cloudyali/cli

Requires Node.js 20 or newer, for the global fetch. The package is @cloudyali/cli on npm; the source is at cloudyali/website/cli.

CloudYali CLI commands

CloudYali CLI commands
CommandWhat it does
cloudyali healthCheck that the CloudYali API is reachable.
cloudyali apiPrint the CloudYali API discovery document.
cloudyali features [--id <id>] [--provider <name>]List CloudYali product capabilities, filtered by capability id or cloud provider.
cloudyali blogs [--limit <n>] [--offset <n>] [--category <slug>]List published CloudYali blog posts.
cloudyali blog <slug>Fetch one CloudYali blog post, body included, rendered as Markdown.
cloudyali openapiPrint the CloudYali OpenAPI 3.1 specification.
cloudyali catalogPrint the RFC 9727 API catalog listing every CloudYali API resource.

Two global options: --json prints the raw { success, data } envelope instead of just the data, and --base-url points at a different deployment.

Using the CloudYali CLI with jq

# What does CloudYali do, and which providers does each capability cover?
cloudyali features | jq '.features[] | {id, name, providers}'

# Only the capabilities that cover Azure
cloudyali features --provider Azure | jq '.features[].name'

# The five most recent posts
cloudyali blogs --limit 5 | jq -r '.posts[].title'

# One post as Markdown, ready to feed to a model
cloudyali blog aws-backup-cold-tier | jq -r '.body_markdown'

CloudYali CLI exit codes

Scripts can branch on the exit code without parsing output.

  • 0 — success.
  • 1 — usage error, unknown command, or an API error. The message carries the code and request_id from the response.
  • 2 — rate limited. The message carries the Retry-After interval, so a retry loop can back off correctly.

CloudYali CLI rate limits and versioning

The CLI talks to the same public API as everything else, so the same rate limit and versioning and deprecation policy apply. It sends User-Agent: @cloudyali/cli/0.1.0 so its traffic is distinguishable in our logs.