Skip to Content
CLIOverview

CLI Overview

The austial CLI scaffolds brand-new projects and generates artifacts into an existing one.

Installation

uv tool install austial # or: pipx install austial / pip install austial

Commands at a glance

CommandPurpose
austial new <name>Scaffold a brand-new project
austial generate <schematic> <name> (alias austial g)Add an artifact to an existing project
austial serveRun the app with auto-reload

Schematics

austial generate/austial g supports four schematics:

SchematicGenerates
moduleA bare @Module()
controllerA bare @Controller() with a find_all stub
serviceA bare @Injectable()
resourceModule + full CRUD controller + service + DTOs + entity, patched into app_module.py

See Usage for new/serve flags, and Generating Resources for exactly what each schematic produces on disk.

Last updated on