Install and scaffold
Austial needs Python 3.11 or newer. Install the CLI with uv, pipx or pip, then scaffold a project and run it. To try it without installing, use uvx austial new my-app.
uv tool install austial
austial new my-app
cd my-app
uv sync
cp .env.example .env
uv run austial serveCommands at a glance
| Command | Purpose |
|---|---|
| austial new <name> | Scaffold a brand-new project |
| austial generate <schematic> <name> | Add an artifact to an existing project (alias: austial g) |
| austial serve | Run the app with auto-reload |
Generate a whole resource
Four schematics are available: module, controller, service and resource. A resource creates a module, a full CRUD controller, a service, DTOs and an entity, and patches app_module.py for you.
austial generate module cats
austial generate controller cats
austial generate service cats
austial generate resource cats # full CRUD moduleWhat the scaffold gives you
- A runnable app on http://localhost:8000 with a root route, a public health check and a guarded health check.
- Swagger UI at /docs.
- Unit and e2e test folders, plus pre-commit hooks for ruff, mypy and pytest.
- An AGENTS.md for AI coding tools, unless you pass --skip-agents.
Frequently asked questions
I get "austial: command not found". What now?
The install folder is not on your PATH yet. With uv, run uv tool update-shell and open a new terminal. With pipx, run pipx ensurepath.
Can I skip the git and dependency steps?
Yes. austial new accepts --skip-install, --skip-git and --skip-agents.
Does austial serve reload automatically?
Yes, reload is on by default. Pass --no-reload for a production-like local run.