runnix
v0.4.6
Published
Runnix CLI: deploy runsets with their worker images, verify worker builds, inspect deploys, promote rollbacks.
Downloads
1,140
Maintainers
Readme
runnix
Command-line tool for Runnix, the PostgreSQL-native workflow orchestration platform: deploy runsets with their worker images, verify worker builds, inspect deploys, promote rollbacks.
npm install -g runnix # or: npx runnix <command>Node 22+. The CLI loads runnix.config.ts and your TypeScript function
modules directly; your project needs no build step.
Commands
| Command | What it does |
| --- | --- |
| runnix deploy | Discover functions, resolve runsets and post the manifests. --image <ref> (or image in runnix.config.ts) names the worker image; the digest is resolved from your own docker after the push. Records git and CI provenance on the deploy. |
| runnix verify | Build/startup guard: checks a worker build carries exactly one runset's complete, current function set. --offline skips the control-plane comparison. |
| runnix deployments | Current deployment per runset. --history [n] lists recent deploys with every runset each shipped. |
| runnix promote --to <deploymentId> | Roll a runset back (or forward) by replaying a previous deployment's snapshot as a new one. |
| runnix init | Scaffold a project. |
| runnix functions list, runnix test <id> | Local discovery and execution without a control plane. |
Remote commands read RUNNIX_URL and RUNNIX_API_KEY (a deploy-scoped key)
from the environment, or take --url.
CI order
runnix verify --offline
docker build -t ghcr.io/acme/billing:$SHA . && docker push ghcr.io/acme/billing:$SHA
runnix deploy --image ghcr.io/acme/billing:$SHA --version $SHA
runnix verifyProduction-type environments refuse an image with no resolvable digest unless
you pass --allow-unpinned.
Documentation
- Runsets and deploys: https://runnix.run/docs/runsets
- Self-hosted worker pools: https://runnix.run/docs/worker-pool
License
AGPL-3.0-or-later. The SDK you import into your functions (@runnix/sdk) is
Apache-2.0.
