TypeScript SDK Reference

The TypeScript SDK uses one promise-based API. Use Runta for new code; there is no separate synchronous client.

Installation

npm install @runta/runta-sdk

Quick start

import { Runta } from "@runta/runta-sdk";

const client = new Runta();
const runtime = await client.runtimes.create();
const result = await runtime.exec("python --version");
console.log(result.stdoutText);

Core

Component	Description
Runta	Configure the TypeScript SDK client and access runtime, secret, and checkpoint operations.
Runtime	Control lifecycle, commands, files, networking, secrets, and checkpoints for one runtime.

Managers

Component	Description
Runtimes	Create, list, and resolve runtimes.
Files	Read, write, upload, and download runtime files.
Secrets	Manage tenant secrets and runtime secret-injection stubs.
Checkpoints	Resolve tenant checkpoints and create runtime checkpoints.
Egress	Read and update runtime outbound network policy.

Shared

Component	Description
Configuration	Client configuration values and config-file helpers.
Runtime Models	Runtime metadata, resources, command results, and operation options.
Secret Models	Tenant secret and secret-injection data structures.
Checkpoint Models	Checkpoint metadata and creation options.
Statuses and Modes	Runtime, checkpoint, agent, and egress state values.
Errors	Errors raised by configuration, API, and command operations.