MicroticaMicrotica

Microtica SDK

A typed TypeScript client for the Microtica API. Manage projects, environments, apps, pipelines, and logs from Node.js with full type safety.

The Microtica SDK is a typed TypeScript client for the Microtica API. It's the contract the rest of the tooling builds on — the CLI is a thin wrapper over it, and any harness or service you write shares the same client and behavior.

Use the SDK when you want to automate Microtica from your own Node.js code: a deployment script, a backend service, a custom internal tool, or an MCP server.

Install

The SDK ships as the @microtica/sdk npm package. You need Node.js 18 or newer.

Terminal
npm install @microtica/sdk

Quickstart

Construct a Microtica client with your credential, then call into one of its namespaces.

TypeScript
import { Microtica } from "@microtica/sdk";

const microtica = new Microtica({
  token: process.env.MICROTICA_TOKEN!,
});

// List the projects your token can access
const projects = await microtica.projects.list();

// List the environments in one project
const envs = await microtica.envs.list(projects[0].id);
console.log(envs);

Every namespace method returns the API response data directly (already unwrapped from the HTTP envelope) and is fully typed.

Namespaces

A single Microtica instance exposes one namespace per resource area.

NamespaceWhat it manages
projectsList and read the projects your credential can access.
envsEnvironments (stages): clone, deploy, wait, update resources, tear down.
appsKubernetes apps: deploy, scale, read status, find deployments.
pipelinesPipelines and builds: create, trigger, list history, stream logs.
componentsReusable infrastructure components and their config schemas.
gitConnected Git accounts, repositories, and branches.
whoamiInspect the stored credential's identity.

Explore

Next steps

On this page