Skip to main content
Use this to develop against OpenGeni or to evaluate it before self-hosting. For a production deployment see Self-host.

Prerequisites

  • Bun
  • Docker with a running daemon. The default sandbox backend and the local infrastructure use it.
  • Model credentials: an OpenAI API key, or another provider configured through the model provider settings.

Start the stack

bun run dev installs dependencies, starts Postgres, NATS, Temporal, and object storage in Docker, runs migrations, builds the local sandbox image, and starts the API, both workers, and the web app. The local stack runs in local access mode: a bootstrap account and workspace with a single dev user and broad permissions. It is for development only.
Ports are chosen per checkout. If a default port is busy, the launcher picks a nearby free one and prints the URLs it actually used.

Configure

.env is the single configuration file. The values you will most likely touch: Model provider credentials never reach the agent sandbox unless you allow them explicitly. The repository’s model providers guide covers inference configuration in depth.

Stop and clean up

dev:down stops this checkout’s infrastructure. bun run dev:clean -- --yes also removes its data and generated runtime environment.

Verify a checkout

Unit tests and typechecks need no running infrastructure:
See CONTRIBUTING.md for the full development workflow and AGENTS.md for operating notes.