# orbitpush > A free, open-source CLI (npm package `orbitpush`) that deploys a static site or SPA to the user's own bunny.net account: a storage zone with a pull zone in front. No orbitpush account or server; the CLI talks only to the bunny.net API with the user's API key. orbitpush deploys finished build output. It does not build sites, and it cannot run server-side rendering, functions or databases. ## Rules for coding agents 1. Run every command with `CI=1` set, for example `CI=1 npx orbitpush deploy`. Agents often run in a pseudo-terminal, where orbitpush would otherwise wait for answers to interactive questions. 2. The API key comes only from the `BUNNY_API_KEY` environment variable. Never write it to a file, commit it, or print it. If it is not set, ask the user to set it. 3. Build the project with its existing build command first. The output directory must exist and should contain `index.html` at its root. 4. If `orbitpush.json` exists in the project root, the site is set up: run `CI=1 npx orbitpush deploy`. 5. If `orbitpush.json` does not exist, ask the user for the project name (letters, numbers, dashes; globally unique on bunny.net) and confirm the output directory, then run: `CI=1 npx orbitpush init --name --dir --yes` Optional flags: `--region ` (default DE, cannot change later), `--delivery-region ` (repeatable, default EU and US), `--replication-region ` (repeatable, cannot be removed later). Then deploy, and tell the user to commit `orbitpush.json`. 6. Never run `destroy`, `disable`, or `deploy --prune-hostnames` unless the user asked for exactly that. `destroy` deletes every file of the site and cannot be undone. 7. Report the URL that `deploy` prints, or the exact error message. ## Domains - `CI=1 npx orbitpush domains add ` adds a domain, prints the DNS record (` CNAME .b-cdn.net`; at a domain root use ALIAS/ANAME/CNAME flattening) and checks DNS once. It exits 1 until the record is set. Give the record to the user, and run the same command again once they have set it. - The first domain becomes the primary domain; later ones are aliases that 301-redirect to it. `--primary` makes an alias the primary domain. - `CI=1 npx orbitpush domains list` shows the status of each domain and exits 1 while any is not connected. - `npx orbitpush domains remove ` removes a domain. ## Exit codes 0 success · 1 error, unknown option, or domain not connected yet · 2 unknown command · 130 cancelled ## Configuration `orbitpush.json` holds the settings and is applied on every deploy. Unknown keys make it invalid. Schema: https://unpkg.com/orbitpush/schema.json - `redirects`: Netlify `[[redirects]]` shape as JSON (`from`, `to`, `status`, `conditions.Country`). `{ "from": "/*", "to": "/index.html", "status": 200 }` turns on SPA mode. - `headers`: Netlify `[[headers]]` shape as JSON (`for`, `values`). - `trailingSlash`: `always` (default), `never` or `ignore` (default in SPA mode). - `_redirects` and `_headers` files are not read. Copy them with `CI=1 npx orbitpush migrate-netlify`. ## Docs - [Getting started](https://orbitpush.run/docs/): requirements and the first deploy - [How it works](https://orbitpush.run/docs/how-it-works/): what a deploy does on bunny.net and which edge rules it manages - [bunny.net limits](https://orbitpush.run/docs/bunny-limits/): edge rules per pull zone, regions that cannot change, hostnames per pull zone - [Version skew](https://orbitpush.run/docs/version-skew/): which old files a deploy keeps for pages still open on the previous build - [AI coding agents and scripts](https://orbitpush.run/docs/guides/agents/): behaviour without a terminal - [Deploy from CI](https://orbitpush.run/docs/guides/ci/): GitHub Actions example - [Custom domains](https://orbitpush.run/docs/guides/custom-domains/) - [orbitpush.json](https://orbitpush.run/docs/configuration/): every field - [Redirects](https://orbitpush.run/docs/configuration/redirects/) and [Headers](https://orbitpush.run/docs/configuration/headers/): what is supported - [Migrating from Netlify](https://orbitpush.run/docs/guides/migrate-from-netlify/) and [from Vercel](https://orbitpush.run/docs/guides/migrate-from-vercel/) - [Commands](https://orbitpush.run/docs/commands/deploy/): init, deploy, domains, migrate-netlify, disable, enable, destroy