Skip to main content

Getting Started

New to Archetect? This section takes you from zero to your first generated project — and even a taste of authoring your own archetype.

Learning path​

  1. What is Archetect? — what problem it solves, why it exists, and when to reach for it.
  2. Installation — install the archetect binary and verify your environment.
  3. Core Concepts — archetypes, catalogs, templates, prompts, and how a render actually flows.
  4. Quick Start — generate a real project from Archetect's default catalog.
  5. Your First Archetype — build and render a minimal archetype of your own in about fifteen minutes.

Prerequisites​

  • A terminal and basic command-line familiarity.
  • git installed and configured — Archetect uses your local git installation to fetch archetypes and catalogs from remote repositories.

No knowledge of Rust, Lua, or template engines is required to use Archetect. When you're ready to author archetypes, the Authoring Archetypes section teaches everything you need, including just-enough Lua.