Qumo Deploy TypeScript SDK

The @qumo-deploy/sdk package provides complete, strongly-typed TypeScript and JavaScript APIs for interacting with the Qumo Deploy control plane. It runs on Node.js, Bun, Deno and in browsers. It covers authentication, signing-key registration, relay discovery, projects, machine identities, and billing. Generating or registering a signing key needs a runtime whose Web Crypto supports Ed25519.

Core Features

Quickstart Guide

Install the package across npm, pnpm, yarn, bun, or Deno and make your first API request.

Client Reference

Learn about QumoClient, configuration parameters, and resource accessors.

Code Recipes

Practical code examples for relay discovery, managing projects, and setting up CI identities.

Error Handling & Types

APIError, IAM role ids, and the exported TypeScript types.

Quick Example

import { QumoClient } from "@qumo-deploy/sdk";

const client = new QumoClient({
  baseUrl: "https://api.qumo-deploy.com",
  token: process.env.QUMO_TOKEN,
});

// Register an Ed25519 signing key; your app signs relay credentials with it.
// Store privateKey on your server: it is returned once and kept nowhere else.
const { key, privateKey } = await client.signingKeys.create(projectId, { name: "backend" });

console.log("Signing key:", key.kid, key.prefix);

TypeScript SDK

SDK Reference

TypeScript SDK Overview

Qumo Deploy TypeScript SDK

Core Features

Quickstart Guide

Client Reference

Code Recipes

Error Handling & Types

Quick Example

​Qumo Deploy TypeScript SDK

​Core Features

Quickstart Guide

Client Reference

Code Recipes

Error Handling & Types

​Quick Example

Qumo Deploy TypeScript SDK

Core Features

Quick Example