Back to Documentation
DocsCLI Referenceyamlr welcome
Last Updated: April 2026

yamlr welcome

Guided Tour

Runs the interactive first-run onboarding wizard. Provides a TUI-based introduction to "The Norway Problem," Yamlr's philosophy, and a quick-start guide.

Usage

bash
yamlr welcome

Description

Automatically triggered on first run if no config is found. Can be re-run manually to view the intro story.

  • Story Mode: Explains "The Norway Problem" and Yamlr's design philosophy.
  • Capability Spotlight: Showcases high-value features (Ghost Services, Resource injection).
  • Health Dashboard: Integrated "Dopamine Drip" dashboard showing real-time repository health.
  • Discovery Dashboard: Dynamic hub for finding hidden documentation and rule directories.

Examples

bash
yamlr welcome

🛡 Global Performance Flags

Available across all commands:

  • --timing: [PERFORMANCE] Output surgical execution timing breakdown.
  • --timing-file <FILE>: [PERFORMANCE] Save performance profiling data to a JSON file.