Getting Started

Requirements

• Rust (stable) — install via rustup
• An SSH key on your machine with access to the framework’s Bitbucket repo, so cargo can fetch it as a git dependency

Install the CLI

One-time install

cargo install --git [email protected]:com7-innovation/oxide.git oxide-cli

Pin to a tag

cargo install --git [email protected]:com7-innovation/oxide.git --tag v0.1.0 oxide-cli

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 by publishing the Sanctum stubs: oxide vendor:publish sanctum, then wire a User entity.
• Write your first migration and entity.
• Add your first controller and routes.