@nimba/api-client

The typed SDK over the Nimba HTTP API. Every Nimba client — CLI, web, anything else — talks to the Nimba server through this package and never imports the engine, the bridge, or the tasks directly.

Part of Nimba, modern Salesforce DevOps orchestration in TypeScript.

Install

npm install @nimba/api-client

Usage

import { NimbaApiClient } from '@nimba/api-client';

const nimba = new NimbaApiClient({
  baseUrl: 'http://localhost:3000',
  token: process.env.NIMBA_TOKEN, // when auth is enabled
});

const flows = await nimba.listFlows();
const result = await nimba.runFlow('dev_org', 'dev'); // (flowName, orgAlias, params?)

What it is

A small, dependency-light client that mirrors the Nimba server's flow/task operations with full TypeScript types (FlowSummary, FlowInfo, FlowRunResponse, …). It has no dependency on the server-internal half of the monorepo — that boundary is the point: clients cross to the engine only over HTTP.

Requirements

• Node.js >= 22.19

Links

• Nimba on GitHub