SDK overview

@edgible-team/sdk is the TypeScript SDK for the Edgible platform — the same client and workflow layer the CLI and webapp are built on, available for you to automate Edgible from your own code. It runs in the browser, in Node, and in CI.

If you have used the edgible CLI, the SDK is the programmable form of everything it does: authenticate, deploy applications, orchestrate multi-app stacks, and wait for work to finish.

What you can do with it

import { createClient } from '@edgible-team/sdk';

const client = createClient({ env: 'prod' });

const me = await client.auth.me();
const apps = await client.organizations.listApplications({ organizationId: me.organizations[0]! });

Manage resources — applications, devices, device pools, storage, organizations, certificates — through namespaced resource clients (client.applications, client.devices, …).
Deploy and wait — kick-off methods return immediately and hand you an Operation with a waitUntilReady() waiter, so you control when to block. See Long-running operations.
Orchestrate stacks — declarative, multi-application YAML with a dependency graph, via client.stacks.

One package, five entry points

The SDK is a single package split into entry points by where the code may run and what it may touch. Almost everyone uses the root import:

Import	For
`@edgible-team/sdk`	The control-plane client and orchestration — the surface for almost everyone. Browser, Node, or CI.
`@edgible-team/sdk/node`	Node-only extras: explicit credential wiring, stack-file loading, VM helpers.
`@edgible-team/sdk/host`	Operating on a device host itself — installing the agent, controlling its daemon. Node, privileged.

Two further entry points (/agent and /admin) are platform-internal and not part of the published developer surface. See Tiers & entry points for the full matrix and the guarantees behind the split.

Where to next

Quickstart — install, authenticate, deploy an application, end to end.
Tiers & entry points — which import runs where.
Authentication & credentials — credential types, the provider chain, token stores, refresh.
Errors — the EdgibleError hierarchy, stable codes, built-in retries.
Long-running operations — waiters, progress callbacks, fire-and-check-later.
Idempotency & safe re-runs — what is and isn’t guaranteed when a script re-runs.
API reference — the generated TypeDoc reference for every public symbol on @edgible-team/sdk and /node.

Not yet on npm. Until the first 0.x release, install from the repo checkout (npm install <path-to>/sdk) or npm link. Requires Node 20+; browser builds are supported.