Skaff documentation overview

Welcome to the Skaff documentation. These guides sit alongside the open-source README and focus on how to scaffold, update, and maintain projects with Skaff's CLI, web app, and template tooling.

Learn the fundamentals

• Introduction — understand what Skaff ships and why.
• Core concepts — terminology around templates, subtemplates, and project state.

Try Skaff quickly

• CLI quickstart — install the CLI and generate your first project.
• Web quickstart — run the Next.js dashboard locally or via Docker.

Deep-dive workflows

• CLI workflows — configure template sources, manage projects, and automate runs.
• Web app guide — manage Skaff projects through the browser interface.
• Template authoring — structure repositories, define schemas, and ship updates safely.

Reference & additional resources

• Configuration reference
• TemplateConfig API
• CLI command reference
• skaff-lib API reference
• template-types-lib API reference
• Examples and recipes
• Contributing guide

Need context on repository setup or release cadence? Check the README alongside these docs.