Atarashi documentation
The user-facing guide to Atarashi: how to use the CLI, what the blueprints do, and how to author your own.
Start here
- Getting started: the 30-second version, then the ideas underneath it.
- Migrating from v0.6: what each old template name maps to, and what changed underneath.
Reference
- CLI reference: every command and flag, printed by the binary.
- Blueprint catalogue: all 36 first-party blueprints.
- Presets: what each one produces, with the full file tree.
- Configuration: settings, precedence, environment variables.
Guides
- Recipes: add auth to an existing project, use it in CI, fork a blueprint, standardise a team's stack.
- Troubleshooting and FAQ: what an error means and what to do about it.
Extending it
- Authoring blueprints: from
create-blueprintto a published package. - Plugin API reference:
@atarashi/plugin-kitin detail.
Generated pages
cli.md, blueprints.md, presets/ and every blueprint's own README are
generated from the thing they describe (the binary's help output, the manifests,
and real generation plans), so they cannot drift:
pnpm build:docs # regenerate
pnpm check:docs # fail if they are out of date
Part of the atarashi documentation, written and maintained by Gautam Suthar.