Skip to main content

SDK CLI Usage

Use the SDK in CLI scripts for scheduled jobs, CI tasks, and operational tooling.

Step 1: Create a Script Project​

mkdir chyper-ops && cd chyper-ops
pnpm init -y
pnpm add @chyper/sdk tsx

Step 2: Configure Environment Variables​

CHYPER_API_BASE=https://your-api-base
CHYPER_API_KEY=your-api-key

Step 3: Write a First Command​

import { ChyperClient } from "@chyper/sdk";

const client = new ChyperClient({
  baseURL: process.env.CHYPER_API_BASE,
  accessToken: process.env.CHYPER_API_KEY,
});

const projects = await client.projects.list();
console.log(`Projects: ${projects.length}`);

Step 4: Add Operational Safety​

  1. Validate required environment variables at startup.
  2. Return non-zero exit codes on failures.
  3. Emit structured logs.
  4. Add retries only for transient failures.

Step 5: Promote to CI​

  • Store credentials in CI secret store.
  • Scope credentials to required actions.
  • Add run notifications for failures.

This approach keeps CLI automation production-safe and auditable.