Quickstart
Deploy your first app with Openship in under 2 minutes.
Get from zero to a live deployment in a few steps.
1. Install the CLI
$ curl -fsSL https://get.openship.io | shInstalls the Openship CLI (Bun runtime, no Node or npm required).
2. Start Openship
openship upRuns the platform locally — API on :4000 and the dashboard on :3001 (downloaded on first run), backed by an embedded database. Local access needs no login. Open it:
openship openPrefer a desktop app or the cloud?
openship install grabs the self-contained desktop app, or sign up for Openship Cloud. For a remote server, openship login --api-url <url> --token <PAT> instead of openship up.
3. Create and link a project
Create a project in the dashboard, then link your working directory to it:
cd your-project
openship init # pick the project to linkThis writes .openship/project.json so later commands know which project to act on.
4. Deploy
openship deployYour app builds and goes live with automatic SSL and a URL. Deploy a preview with openship deploy --env preview.