TypeScript SDK overview

@dsplane/core is the TypeScript API layer used by DS Plane CLI. Hey API generates it from the OpenAPI document in the DS Plane repository.

Choose the CLI or SDK

If you are	Use	Why
Managing Dev Spaces from a terminal	DS Plane CLI	Interactive flows and focused commands are already implemented.
Building a TypeScript integration	@dsplane/core	You control client configuration and API calls in your process.
Adding behavior to DS Plane CLI	@dsplane/core	The CLI uses the same generated classes and response types.

SDK structure

The root package exports DSPlaneCore, service classes, generated models, and operation response types.

import {
  DSPlaneCore,
  EnvironmentState,
  type EnvironmentCurrentState,
} from '@dsplane/core';

Create the underlying Fetch client from the client export:

import { createClient } from '@dsplane/core/client';

DSPlaneCore exposes two service groups:

Property	Class	Operations
wsManager	WsManager	Dev Spaces, schemas, environment types, and SSH keys.
deployments	Deployments	AI deployment listing.

Generated behavior

The generator is configured to:

• Use the Hey API Fetch client.
• Return response data directly.
• Generate instance methods with flat operation parameters.
• Preserve the DSPlaneCore container name.
• Group /ws-manager/ and /key operations under wsManager.
• Group /llm/ operations under deployments.

See Generated-code conventions before editing or regenerating SDK files.

Next steps

• Follow the SDK quickstart.
• Configure authentication in Client configuration.
• Browse the API reference.