Getting started

Create a standalone Boson application with the CLI, then iterate on a product capability using the public Capability SDK. You supply infrastructure through configuration; Boson owns migrations and its application process lifecycle.

Prerequisites

• Rust 1.94 or newer
• Git
• A PostgreSQL database you own

Install the CLI from the Boson repository:

cargo install --git https://github.com/Systograms/boson boson-cli

Scaffold an app

boson create my-app --database-url postgres://user:pass@localhost:5432/my_app
cd my-app

boson create writes a workspace with:

• thin server, worker, and migrate binaries
• a shared apps/app composition crate
• a starter items capability
• project identity in .boson/project.toml
• typed local configuration in .boson/config.yaml

Boson never creates PostgreSQL. Pass --database-url or edit .boson/config.yaml to point at a database you already run.

Verify and start

boson doctor
boson start

boson doctor checks configuration and PostgreSQL connectivity. boson start applies pending migrations, starts the Server and Worker, waits for health, and streams logs with service prefixes. Press Ctrl+C to stop Boson's processes.

Boson never creates or stops PostgreSQL, storage, email, containers, or other infrastructure.

Operate

boson status
boson logs
boson logs server --follow
boson doctor
boson config
boson deploy
boson stop

boson deploy packages migrate, Server, and Worker images. It never provisions cloud resources.

Update the CLI

boson update --check
boson update

Example application

The repository includes a complete standalone example at examples/my-api that demonstrates authenticated routes, Admin scopes, transactional events, and capability migrations.