CLI reference (`atlantus`)

Install the binary first: Install.

atlantus --version
atlantus --help

Everyday commands

Command	Purpose
`atlantus new <name>`	Scaffold a new app
`atlantus new <name> --with-auth`	Scaffold with auth stubs
`atlantus check --path .`	Structure + compile
`atlantus dev --path .`	Development server
`atlantus dev --watch`	Hot reload on `.atl` changes
`atlantus start --path .`	Production-shaped serve
`atlantus build --path .`	Compile / emit artifacts
`atlantus db migrate --path .`	Apply SQL migrations

Useful flags

atlantus dev --path . --host 127.0.0.1 --port 3000
atlantus start --path . --host 0.0.0.0 --port 8080

Project root

--path points at the directory with atlantus.toml (your app).
After atlantus new my-api && cd my-api, that is ..

Generators & extras

Depending on version, also available via atlantus --help:

gen — route/service stubs
fmt — format .atl
openapi — OpenAPI from routes
job work — worker loop for durable jobs

Not required

You do not need cargo, rustc, or a checkout of the framework to use these commands. Those appear only in contributor docs for people building Atlantus itself.

Next: Deploy.

Keyboard shortcuts