Install the SDK
Install the preview package and use its JavaScript, TypeScript, and CLI entry points.
Requires Node.js 22 or later. ESM, CommonJS, and TypeScript declarations are included.
Install the preview
The published [email protected] package is CLI-only. To use the SDK from this checkout:
-
Build the public package from the repository root:
bun install --frozen-lockfile bun run build:sdk -
Create a tarball. Use the filename printed by
npm pack:cd packages/openship npm pack -
Install that tarball in your Node project:
npm install /absolute/path/to/openship-0.7.2.tgz
After an SDK-enabled release is published, this becomes npm install openship. A local tarball and
the existing npm release can share a version number while containing different exports.
Choose an import
| Import | Provides |
|---|---|
openship | Native factory, remote clients, deployment helpers, public types, and errors. |
openship/client | Remote clients and HTTP helpers. |
openship/native | Native factory, identity types, lifecycle options, and scoped operations. |
import { createShip, OpenshipClient } from "openship";
import type { ScopedShip, ProjectOperations } from "openship";const { OpenshipClient } = require("openship/client");
const { createShip } = require("openship/native");Imports are passive. An import does not start the CLI, open a database, or create a worker.
Use the CLI from the same installation
npx openship --helpInstalling the dependency locally provides both application imports and the command through npx or
npm scripts. A global CLI installation does not replace your application's local dependency.
Continue with remote setup, native setup, or the runnable example. See compatibility for server requirements.