zodiac CLI
The zodiac command is the CLI for scaffolding Zodiac-based projects. Use the zodiac extra when you want the CLI; use zodiac-core alone when only the library is needed in a project.
Install
uv add must be run from within a project directory. Create one first with uv init if needed (see Installation).
Commands
zodiac --help— show top-level help and subcommands.zodiac new PROJECT_NAME --tpl TEMPLATE_ID -o OUTPUT_DIR— generate a new project from a template.
Options (zodiac new)
| Argument / Option | Required | Description |
|---|---|---|
PROJECT_NAME |
Yes | Name of the project. |
--tpl / template |
Yes | Template id. Currently supported: standard-3tier. |
-o / --output |
Yes | Directory where the project will be generated. |
-f / --force |
No | Allow generation into an existing target directory without removing unrelated files. |
Example
This creates ./projects/my_app/. For the full scaffold-from-scratch flow (init → add → generate → run), see Getting Started.
Generated Project Architecture
The standard-3tier template uses a 3-tier layered architecture with dependency injection. See Getting Started or Architecture Guide for details.