Skip to content
Andurel.Docs
latest

Version

latestlatest1.5.2
Getting Started / latest

Installation

Install the Andurel v2 CLI, create an application, and start its development server.

Requirements

You need:

  • Go 1.27.3 or newer
  • PostgreSQL
  • Linux or macOS on amd64 or arm64
  • Node.js and a JavaScript package manager for the Inertia frontend; managed SSR requires Node.js 22 or newer
  • Docker only if you want to run the database-backed test suites, which use testcontainers

Install the CLI

v2 lives on its own module path. Install the latest beta:

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

Pin a version when reproducibility matters:

1go install github.com/mbvlabs/andurel/v2@v2.0.0-beta.1

v1 releases stay on the unversioned module path (github.com/mbvlabs/andurel@v1.x.y), and that path's @latest never jumps to v2.

Create an application

1andurel new orbit
2cd orbit
3andurel tool sync
4andurel skill install --harness opencode
5cp .env.example .env
6andurel db create
7andurel db migrate up
8pnpm install
9andurel run
  • andurel new writes the project but does not create .env or install tools.
  • andurel tool sync downloads the pinned binaries (templ, narsilc, goose, tailwindcli, shadowfax, mailpit, and the database consoles) into bin/.
  • andurel skill install copies the embedded agent skill into your harness; the harness names are claude, codex, opencode, pi, and crush.
  • Fill in DB_HOST, DB_PORT, DB_NAME, DB_USER, and DB_PASSWORD in .env. andurel db create is a no-op when the database already exists.
  • pnpm install installs the frontend dependencies. Use your chosen package manager's install command instead when you create a non-pnpm project.

The app is served at http://localhost:8080. To capture development email in Mailpit, run andurel run --tools mailpit and open http://localhost:8025.

Choose a UI

Every new project uses Inertia. Pick the adapter and JavaScript package manager with --ui:

1andurel new orbit                    # Inertia React with pnpm (the default)
2andurel new orbit --ui react/pnpm
3andurel new orbit --ui vue/bun
4andurel new orbit --ui svelte/npm

The adapter is react, vue or svelte; the package manager is pnpm, bun or npm. The selection is recorded in andurel.toml.

Check the install

1andurel verify
2andurel doctor --json

andurel verify runs gofmt, go fix, go vet, the typed layer rules, and generated-code drift. It exits non-zero when something needs fixing and prints a fix for each violation. --with-tests also runs go test ./....

Next, read Directory Structure to learn where each kind of code lives.