Scalar Galaxy

This library provides convenient access to the Scalar Galaxy REST API from the command line.

The full API of this library can be found in api.md.

• Installation
• Usage
• API Reference
• Shell Completion
• Manual Pages
• Authentication
• Errors
• Client Options
• Retries and Timeouts
• Helpers
• Logging
• Requirements

# npm (requires Node.js)
npm install -g @scalar/galaxy-cli

# Homebrew — standalone binary, no Node.js required
brew install scalar/galaxy-cli-tap/galaxy

# Direct download — standalone binary, no Node.js required
curl -fsSL https://github.com/scalar/galaxy-cli/releases/latest/download/galaxy-$(uname -s | tr '[:upper:]' '[:lower:]')-$(uname -m | sed 's/x86_64/x64/;s/aarch64/arm64/').tar.gz | tar xz
sudo mv galaxy /usr/local/bin/

# Windows — download and extract galaxy-windows-x64.zip, then add it to PATH
# https://github.com/scalar/galaxy-cli/releases/latest/download/galaxy-windows-x64.zip

galaxy [resource] [command] [flags]

galaxy planets list-all-data --bearer-auth "$BEARER_AUTH" --limit '10' --offset '0'

The examples in the following sections assume a client configured as shown above.

See the API reference for every available operation.

galaxy completion <shell> prints a completion script for bash, zsh, and fish. Add the matching line to your shell startup file to complete commands, subcommands, and flags with Tab.

# bash (~/.bashrc)
eval "$(galaxy completion bash)"

# zsh (~/.zshrc)
eval "$(galaxy completion zsh)"

# fish (~/.config/fish/config.fish)
galaxy completion fish | source

Installing the package globally also installs man pages. man galaxy lists every command, and each command has its own page named after the command with spaces and : replaced by -.

man galaxy
man galaxy-<resource>-<command>

Pass credentials to the generated client constructor. Environment variables are read automatically when supported by the target runtime.

Declared schemes:

• bearerAuth bearer token
• basicAuth basic authentication
• apiKeyHeader API key in header X-API-Key
• apiKeyQuery API key in query api_key
• apiKeyCookie API key in cookie api_key
• oAuth2 OAuth2/OpenID Connect
• openIdConnect OAuth2/OpenID Connect

Failed requests print a structured error to standard error and exit with a status that identifies the failure class. The error body carries the API's own message plus a stable code, the HTTP status, the requestId, and — where one applies — an actionable hint. Usage errors (exit 2) are reported as a plain message instead, since no request was made. Exit statuses: 0 success, 1 error, 2 usage, 10 auth-failed, 11 not-found, 12 rate-limited, 13 client-error, 14 server-error, 15 connection-error.

Documented error statuses: 400, 401, 403, 404, 409, 422, 429.

Configure the generated client by setting any of these options when you create it.

Generated clients support request timeouts and retry temporary failures such as network errors, 408, 409, 429, and 5xx responses. Retry delays honor Retry-After headers when present. Tune the retry and timeout client options shown above, or override them per request.

• --format <format> — output format: auto, json, jsonl, pretty, raw, toon, or yaml.
• --format-error <format> — error output format: auto, json, jsonl, pretty, raw, toon, or yaml.
• --format toon — token-efficient structured output for AI agents; uniform lists collapse into one header plus a row per item, with a definitive item count.
• --transform <path> and --transform-error <path> — dot-path transform for data/error output.
• --raw-output, -r — print transformed string values without JSON quotes.
• --max-items <count> — bound iterator, streaming, and WebSocket command output.
• Errors carry a stable code and an actionable hint beside the API's own message, and each failure class exits with its own status: 1 error, 2 usage, 10 auth-failed, 11 not-found, 12 rate-limited, 13 client-error, 14 server-error, 15 connection-error.

• Pass --debug to any command to enable SDK debug logging on stderr.

• Node.js 20 or newer — for the npm install only; the standalone binaries bundle their own runtime.

Powered by Scalar.