Search documentation

Find a page in the Andurel docs.

Installation

Install the CLI built from Andurel's master branch, create a v2 application, and start its development server.

Requirements

You need:

  • Go 1.27 or newer
  • PostgreSQL
  • Linux or macOS on amd64 or arm64
  • Node.js and a package manager only when using Inertia; managed Inertia SSR requires Node.js 22 or newer

Install the v2 development CLI

The stable @latest tag remains v1 until v2 is released. Install master to work with the version described by these docs:

1go install github.com/mbvlabs/andurel@master
2andurel --version

Because master is a development branch, pin a commit when reproducibility matters.

Create an application

1andurel new orbit
2cd orbit
3andurel tool sync
4cp .env.example .env
5andurel database create
6andurel database migrate up
7andurel run

Edit .env before creating the database. The server is available at http://localhost:8080 by default and reloads Go, Templ, CSS, and generated sqlc code as needed.

Choose a frontend

The default project uses Templ and Datastar. Select an Inertia adapter and, optionally, its JavaScript package manager when creating the project:

1andurel new orbit --inertia vue
2andurel new orbit --inertia react/pnpm
3andurel new orbit --inertia svelte/bun

The supported adapters are Vue, React, and Svelte. The supported package managers are npm, pnpm, bun, and yarn.