Skip to main content

ᛊ Getting Started with Yggdrasil CLI

The Yggdrasil CLI is your interface to the Nine Realms. Version 6.5 ships with 19 slash commands, realm-aware project scaffolding, and full AI agent integration.

Prerequisites​

  • Node.js ≥ 20.0.0
  • Git ≥ 2.40
  • A terminal that supports ANSI colors (virtually any modern terminal)

Installation​

Install globally via npm
npm install -g @brierstudios/yggdrasil-cli@latest
Or use with npx (no global install)
npx @brierstudios/yggdrasil-cli@latest --help

Verify the installation:

yg --version
# → 6.5.0

First Commands​

Initialize a realm​

Create a new project in a realm
yg init --realm midgard --name my-app

This scaffolds a new project within the Midgard realm (personal apps). The CLI generates:

  • Project directory with realm-appropriate configuration
  • REGLAS_YGGDRASIL.md — Realm-specific development rules
  • .yggdrasil.yml — Realm manifest file
  • Initial git repository with realm-typed branches

List available realms​

yg realms list

Output:

╭─────────────────────────────────────╮
│  <span class="ri ri-ecosystem">ᛜ</span> Yggdrasil — Nine Realms         │
├──────┬────────────┬──────────────────┤
│  #   │ Realm      │ Description       │
├──────┼────────────┼──────────────────┤
│  1   │ Asgard     │ Core Technology   │
│  2   │ Vanaheim   │ AI Agents         │
│  3   │ Alfheim    │ UI Prototypes     │
│  4   │ Svartalfheim│ Knowledge & Docs │
│  5   │ Muspelheim │ Active Dev        │
│  6   │ Niflheim   │ Resources & Assets │
│  7   │ Helheim    │ Archive           │
│  8   │ Jotunheim  │ Massive Projects  │
│  9   │ Midgard    │ Personal Apps     │
╰──────┴────────────┴──────────────────╯

Check realm status​

yg realms status

Shows the current health and activity of each realm — active projects, recent commits, and deployment status.

Deploy to a realm​

yg deploy --realm asgard --env production

Configuration​

The CLI reads from .yggdrasil.yml at your project root:

.yggdrasil.yml
realm: midgard
name: my-personal-app
version: "1.0.0"
agents:
  - discord-bot
  - telegram-agent
conventions:
  enforce: true
  auto-format: true

What's Next?​