Skip to main content

User Guide

Everything about using Archetect day to day — rendering archetypes, navigating catalogs, automating input, and tuning your configuration. (Creating archetypes is covered separately in Authoring Archetypes.)

In this section

  • Rendering Archetypes — sources, destinations, caching, previews.
  • Using Catalogs — browsing, searching, and dispatching by path.
  • Answers & Automation — pre-answering prompts, answer files, defaults, and headless operation.
  • Switches — toggling optional archetype behavior.
  • Configuration — global and project configuration, offline mode, security.
  • IDE & Tooling — editor support, shell completions, cache management, diagnostics.

The commands you'll actually use

CommandPurpose
archetectBrowse your configured catalog interactively
archetect <path> [dest]Dispatch straight to a catalog entry (e.g. archetect archetect/rust/cli/clap-cli)
archetect render <source> [dest]Render an archetype from a git URL or local directory
archetect lsPrint the resolved catalog tree
archetect search <terms>Full-text search across the catalog
archetect checkDiagnose your environment

For every command and flag in detail, see the CLI Reference.