Skip to main content

Archetect

Archetect is a code-centric, language agnostic content generator, capable of generating single files, complex projects, or entire architectures.

When You Need This

Archetect is only required if your organization allows projects to be created locally using templates. If projects are created through a centralized portal or CI/CD system, you do not need to install Archetect.

Archetect GitHub

Installation​

A Windows Installer is available on the Archetect GitHub Releases page. The installer will be named like archetect-vX.X.X-windows-x86_64-installer.exe.

Download and run the installer:

  1. Download the installer from the releases page
  2. Run the installer
warning

Windows may view this installer as coming from an "Untrusted Source". You will need to override the exceptions to allow the installation.

The installer automatically:

  • Adds archetect to Path environment variable
  • Sets core.longpaths=true to support Long File Path for Git
  • Sets registry HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem\LongPathsEnabled to 1 to enable Long Path Support for Windows
info

The Windows x86_64 installer works on both x86_64 and arm64 architectures.

Alternative: Manual installation from binary

If you prefer to use the pre-compiled binary directly:

# Download the appropriate binary from releases page
# Extract and place in a directory on your PATH

# Enable Git with Long File Name Support
git config --global core.longpaths true

# Enable Windows OS Long File Name Support (requires admin privileges)
# Set HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem\LongPathsEnabled to 1

Install From Source (All Platforms)​

If you have Rust installed, you can build Archetect from source on any platform:

git clone git@github.com:archetect/archetect.git
cd archetect
cargo install --path archetect-bin

This method works on Windows, macOS, and Linux.

Verify Installation​

archetect --version