Get Started

Get Started

Step 1

Install

Latest version: 0.17.0

Option 1: Windows Installer

Download the file ending in _windows_setup.exe from GitHub Releases ↗ and run it. If you see a "Windows protected your PC" dialog, click "More info", then "Run anyway".

Option 2: One-line PowerShell install script

irm https://shadop.dev/archmage/install.ps1 | iex

Option 1: Homebrew

brew install shadowopera/tap/archmage

Option 2: One-line install script

curl -fsSL https://shadop.dev/archmage/install.sh | bash

Option 3: macOS Installer

Download the file ending in _macos.pkg from GitHub Releases ↗ and open it. The standard macOS installation prompts will guide you through the setup.

Option 1: Homebrew

brew install shadowopera/tap/archmage

Option 2: One-line install script

curl -fsSL https://shadop.dev/archmage/install.sh | bash

Option 3: Linux archive

Download a Linux .tar.gz archive from GitHub Releases ↗. Each archive includes a README.md with detailed installation instructions.

Step 2

Scaffold a project

Step 2.1

Open a terminal

  • Option 1: Click the Start button (the Windows logo) on the taskbar, type PowerShell or Terminal, then click Windows PowerShell or Terminal in the search results.
  • Option 2: Right-click the Start button, then select Windows PowerShell or Terminal from the menu that appears.
  • Option 1: Open Finder → Applications → Utilities → Terminal.
  • Option 2: Open Mission Control (swipe up with three or four fingers on the trackpad), type Terminal in the search field at the top, and press Enter.
  • Option 1: Press Ctrl + Alt + T (supported on many Linux distributions).
  • Option 2: Search your application menu for Terminal or your terminal app.

Step 2.2

Navigate to your workspace

Choose a directory where you want to create the project. Replace the example path below with your actual path:

cd C:\path\to\your\workspace
cd /path/to/your/workspace
cd /path/to/your/workspace

Step 2.3

Initialize the project

Run the following command:

archmage init --language cs ./my-project     # or --language go

This command scaffolds a minimal project to give you a running start, including sample configurations, enum definitions, and ready-to-use scripts. See Quickstart ↗ for more information.