Getting Started

Requirements

• Rust (stable) — install via rustup

Install the CLI

cargo install oxide-cli --registry com7-innovation

See Internal Registry for one-time kellnr setup (token + cargo config) if you haven’t done it yet.

Confirm:

oxide --version

Create a project

1. Scaffold

   oxide new billing-api
   cd billing-api

   oxide new supports --branch <name>, --tag <version>, and --rev <sha> for pinning the framework version. Default is branch = "main".

2. Wire environment

   cp .env.example .env

   Edit .env — set DB_CONNECTION, DB credentials, and APP_LISTEN as needed.

3. Run migrations

   oxide migrate

4. Start the server

   oxide serve

   Default address is 127.0.0.1:8000. Hit http://localhost:8000/api/v1/health to confirm.

What’s next

• Add authentication: enable the oxide-auth dep, then wire a User entity and run oxide vendor:publish sanctum.
• Write your first migration and entity.
• Add your first controller and routes.