Runnable examples
Run the installed SDK through a complete local project lifecycle.
The package includes an executable example that uses public imports, real storage, and the shared deployment pipeline.
Run the native lifecycle
After installing openship in a Node project:
node node_modules/openship/examples/native-lifecycle.mjsCopy that file into your project to adapt it. The example:
- Provisions two users and selects their organization scopes.
- Deploys generated HTML and waits for a ready release.
- Updates configuration and deploys new files into the same project.
- Checks deployment history, tenant isolation, and session revocation.
- Closes and reopens persistent storage, then checks saved configuration and masked secrets.
- Deletes the project, drains the installation, and removes its temporary state.
Assertions fail the process if a step does not behave as expected. The example creates its own temporary directory and needs no API credential, Docker daemon, or external database.
What it verifies
The installed-package checks run this exact file outside the repository on Node 22 and 24 and typecheck it against the public declarations. Related package probes check release-file contents, reopening, physical cleanup, ESM/CommonJS imports, and the installed CLI.
The example uses the bare runtime with routing: "none", so it does not serve a public URL.
Live Cloud, Docker, SSH, and public routing are separate integration checks.
Adapt a smaller workflow
| Task | Example |
|---|---|
| Connect to your installation | Remote client |
| Deploy your application directory | Complete remote example |
| Embed a persistent installation | Native setup |
| Create a customer workspace | Identity provisioning |
| Deploy generated files or a directory | Deployment workflows |
| Handle errors or stream logs | Results and errors |
| Scale apps, databases, and shared files | Scaling with the SDK |
| Use the CLI against native storage | Native CLI |