Skip to main content

ᚨ CLI Command Reference

Yggdrasil CLI v6.5 ships with 19 slash commands organized into five categories: Project, Realm, Agent, Deploy, and Utility.

Project Commands

/init

Initialize a new project within a realm.

yg init --realm <realm> --name <project-name> [--template <template>]
FlagTypeDefaultDescription
--realmstringmidgardTarget realm (1–9)
--namestringrequiredProject name
--templatestringdefaultScaffold template

/status

Display the current project status — active branches, recent builds, and deployment state.

yg status [--verbose]

/build

Trigger a build for the current project, respecting realm-specific configurations.

yg build [--env <env>] [--no-cache]

/test

Run the project's test suite with realm-aware test discovery.

yg test [--watch] [--coverage] [--filter <pattern>]

/lint

Enforce REGLAS_YGGDRASIL.md conventions and code quality checks.

yg lint [--fix] [--realm-check]

Realm Commands

/realms list

List all Nine Realms with their current status.

yg realms list [--format <json|table>]

/realms status

Show detailed per-realm health: active projects, deployment state, resource usage.

yg realms status [--realm <realm>]

/realms enter

Switch into a realm context — updates shell prompts, environment variables, and path configurations.

yg realms enter <realm>

/realms migrate

Migrate a project between realms (e.g., from Muspelheim → Asgard when promoted).

yg realms migrate --project <name> --from <realm> --to <realm>

Agent Commands

/agent create

Create a new AI agent configuration (Discord bot, Telegram agent, or custom personality).

yg agent create --type <discord|telegram|custom> --name <agent-name>

/agent deploy

Deploy an agent to its target platform.

yg agent deploy --name <agent-name> [--env <env>]

/agent personality

Configure a personality profile for an agent using the Lilith personality system.

yg agent personality --name <agent-name> --profile <profile>

/agent chat

Open an interactive chat session with a deployed agent for testing.

yg agent chat --name <agent-name>

Deploy Commands

/deploy

Deploy the current project to a specified realm and environment.

yg deploy --realm <realm> --env <env> [--dry-run]
FlagTypeDefaultDescription
--realmstringcurrentTarget deployment realm
--envstringstagingEnvironment (staging, production)
--dry-runbooleanfalseSimulate deployment without executing

/deploy rollback

Roll back the most recent deployment to a previous stable state.

yg deploy rollback --realm <realm> [--version <version>]

/deploy logs

Stream deployment logs in real time.

yg deploy logs --realm <realm> [--follow] [--tail <lines>]

Utility Commands

/config

Get or set Yggdrasil configuration values.

# Read a config value
yg config get <key>

# Set a config value
yg config set <key> <value>

# List all configuration
yg config list

/update

Check for and apply CLI updates.

yg update [--check] [--force]

/help

Display help information for any command.

yg help [command]

Global Flags

These flags apply to all commands:

FlagDescription
--verboseEnable verbose output with debug information
--quietSuppress all non-essential output
--no-colorDisable ANSI color output
--config <path>Specify an alternative config file path
--dry-runSimulate the command without real side effects

Exit Codes

CodeMeaning
0Success
1General error
2Realm not found
3Configuration error
4Deployment failed
5Agent error

Tip: Use yg <command> --help for detailed help on any command. Shell completions are available via yg completions install.