Skip to content

Local Axern

axern local up is the supported local installation. The CLI contains the version-matched deployment bundle, generates local identity material, invokes Docker Compose v2, and configures the public gateway context.

It is a machine-level instance: you can run the command from any directory and do not need an Axern project file.

Terminal window
axern local up
axern local image load python:3.12-slim --pull
axern local status

Starting again is idempotent. Existing PostgreSQL, runtime, and identity data is preserved. If another context is already selected, local up does not replace it; use axern local up --use when you want to switch.

Optional local telemetry is deliberately excluded from the cold-start path:

Terminal window
axern local up --profile observability
Terminal window
axern local doctor
axern local logs
axern local logs gatewayd --follow --tail 100

doctor is read-only and reports an executable recommendation for each failed check. Use --output json with status or doctor in automation.

Terminal window
axern local down
axern local reset --force
axern local up

down removes containers and the network but keeps data. Local state is intentionally rebuild-only across versions: export required outputs, then use reset --force and up. reset permanently deletes the instance and requires interactive confirmation without --force.

To locate the data without relying on platform-specific paths:

Terminal window
axern local path

See the axern local reference for ports, paths, proxy handling, failure recovery, and complete command behavior.

Repository Compose scripts and source-built :dev images are contributor tools, not an installation path. If you are changing Axern, follow the contributor guide and the local deployment README in the repository.