celerdata-byoc-cli

Preview: This CLI is currently in preview.

The preview command-line interface for CelerData BYOC Cloud based on OpenAPI. Manage your clusters directly from the terminal or automate operations in CI/CD pipelines and AI agents.

Why celerdata-byoc-cli?

Most cloud management tasks require navigating a web console. celerdata-byoc-cli brings the full CelerData BYOC Cloud control plane to your terminal, enabling:

• AI agent workflows — Claude, Gemini, Codex, and other agents can manage your clusters as part of larger automations; with remote control features offered by some AI platforms, you can even manage CelerData BYOC clusters from your phone
• Scheduled operations — combine with agent cron capabilities or CI schedules to automate routine tasks: suspend dev clusters after hours, resume before work, scale up for known traffic peaks — saving costs without manual intervention
• CI/CD automation — suspend clusters on a schedule, scale before batch jobs, release after testing
• Scripting — compose cluster operations with standard shell tools; structured JSON output makes it easy to extract values and chain commands

Features

Cluster

deploy · list · get · state · endpoints · suspend · resume · scale-num · scale-type · release

Cluster Volume

cluster volume modify

Warehouse

list · get · create · suspend · resume · scale-num · scale-type · release

Auth & Config

auth login/logout/status · config init/list/get/set/use-profile

Installation

Requires Node.js 16+ and macOS Apple Silicon (M1/M2/M3/M4).

npm install -g preview-celerdata-byoc-cli

The pre-built binary is bundled in the npm package — no additional downloads or GitHub access required.

Verify

celerdata-byoc-cli version

Update

Re-run the installation command to fetch the latest version.

Uninstall

npm uninstall -g preview-celerdata-byoc-cli

Quick Start

1. Configure

celerdata-byoc-cli config init

You will be prompted for:

• API URL — your CelerData Cloud API endpoint (e.g. https://cloud-api.celerdata.com)
• Client ID — from your service account or application key
• Client Secret — from your service account or application key
• Profile name — defaults to default

See API Overview for how to obtain your Client ID and Client Secret.

2. Authenticate

celerdata-byoc-cli auth login

The CLI fetches an OAuth2 access token and caches it at ~/.celerdata-byoc-cli/tokens/default.json. Tokens expire after 1 hour and are refreshed automatically.

3. List your clusters

celerdata-byoc-cli cluster list

AI Agent Integration

The CLI is designed for use by AI agents (Claude, Gemini, Codex, etc.) as a subprocess tool.

Skills

Skills are automatically installed to ~/.agents/skills/ when you run npm install. They teach AI agents how to use this CLI correctly — covering authentication, safety rules, command usage, and common patterns. Skills are updated automatically when you upgrade the package.

| Skill | Description | | --- | --- | | celerdata-shared | Setup, authentication, output parsing, async operations, safety rules (auto-loaded by all other skills) | | celerdata-cluster | Cluster lifecycle: deploy, inspect, scale, suspend/resume, release, disk configuration | | celerdata-warehouse | Warehouse lifecycle: create, inspect, scale, suspend/resume, release |

For agent flags (--format json, --no-confirm, --wait, etc.) and more workflow patterns, see docs/reference.md — AI Agent Usage.

For full command reference, CI/CD setup, output formats, exit codes, and global flags, see reference.md.

Example — Claude Code managing a cluster

You: "Suspend the staging cluster and wait for it to complete."

Claude Code runs:

# 1. Find the cluster ID
celerdata-byoc-cli cluster list --format json --no-color

# 2. Suspend it and wait
celerdata-byoc-cli cluster suspend cls-abc123 \
  --format json --no-confirm --wait --wait-timeout 10m

# 3. Confirm the final state
celerdata-byoc-cli cluster state cls-abc123 --format json