AI coding agents and scripts
How orbitpush behaves without a terminal, so scripts and coding agents can run it safely.
orbitpush asks nothing when it runs without a terminal: when stdin or stderr is not a terminal, or when CI is set to anything but false or 0. Every question then has to be answered by a flag, and the API key comes from BUNNY_API_KEY.
export BUNNY_API_KEY=...
npx orbitpush init --name my-site --dir dist --region DE --delivery-region EU --delivery-region US --yes
npm run build
npx orbitpush deploy
npx orbitpush domains add www.example.com # prints the DNS record, exits 1 until it is set
Coding agents: set CI=1
Some coding agents run commands in a pseudo-terminal, where orbitpush would ask its questions and wait for an answer that never comes. Set CI=1 for them:
CI=1 npx orbitpush deploy
Then nothing asks, and domains add checks DNS once instead of waiting up to 15 minutes.
Agents can also read /llms.txt, which gives them these rules in a compact form.
Rules without a terminal
- Commit
orbitpush.jsonafterinit. Without a terminal,deploynever creates a site. It stops when the file is missing. initneeds--nameand--dir, or--yesto take the defaults, so a guessed name never creates zones.deploy,disableandenabletake no input.destroyneeds--yes.domains addchecks DNS once instead of waiting, and exits with1while the domain is not connected. Run it again a few minutes later.domains listexits with1while any domain is not connected, so a script can poll it.
Exit codes
| Code | Meaning |
|---|---|
0 |
Success |
1 |
An error, an unknown option, or a domain that is not connected yet |
2 |
Unknown command |
130 |
Cancelled with Ctrl+C |
Errors go to stderr. An unknown option stops with 1, so a typo never falls back to a default.
Recommendations for agent instructions
If you let an agent deploy for you, tell it to:
- Build the project with its existing build command, and check that the output directory has
index.htmlat its root. - Run
CI=1 npx orbitpush deploywhenorbitpush.jsonexists. - Otherwise ask you for the project name and regions, then run
initwith explicit flags. - Never run
destroy,disableordeploy --prune-hostnamesunless you asked for it. - Report the URL that
deployprints, or the exact error.