Orbit Handbook
MarkdownOpen in ClaudeOpen in ChatGPT

Getting Started

From zero to a first deploy in about five minutes.

1. Install the CLI

curl -fsSL https://get.orbit.example/install.sh | sh
orbit version   # orbit 0.4.2

More platforms and CI recipes: Installation.

2. Describe your service

Run orbit init in your repository. It detects the runtime and writes a
minimal orbit.yaml:

app: hello-api
build: docker
environments:
  staging:
    url: https://staging.hello.example
  production:
    url: https://hello.example
    protect: true

3. Ship it

orbit deploy --env staging

Orbit builds, uploads, and shows the plan before anything changes:

Release #1 -> staging
  + service hello-api (new)
  + route https://staging.hello.example
Apply? [y/N] y
  build   ok  (42s)
  push    ok  (11s)
  switch  ok  (0.3s)
Release #1 is live.

4. Promote to production

orbit promote --from staging --to production

A promote reuses the exact artifact that ran in staging - nothing is rebuilt,
so what you tested is what ships. protect: true environments always require
a confirmation.

Next steps