The dot Command
dot is the single binary that manages these dotfiles. It is compiled from dot/ in the repo (Bun + Effect v4 + OpenTUI) to a single executable, stowed to ~/.local/bin/dot.
It has two faces:
- A TUI dashboard — run
dotwith no arguments to open the interactive menu, with git diff/log views, GitHub workflow runs, the notification inbox, repo notes, Omarchy menus, git staging, and AI commit suggestions. - A native CLI — every action is also a subcommand (
dot update,dot git-diff --raw,dot doctor, …), suitable for scripts and status bars.
Command Reference Every command, alias, flag, and example, generated from the CLI registry.
Stow Workflow How packages are stowed into your home directory.
Notes & Handoffs The repository notes browser and handoff workflow.
System Utilities Health checks, benchmarks, and optional timers.
Common commands
Section titled “Common commands”| Command | What it does |
|---|---|
dot init | One-time first-use setup for a fresh machine. |
dot update | Self-update, install deps, rebuild, pull, stow, restart. |
dot stow | Stow refresh only (no git pull). |
dot doctor | Run dotfiles system health checks. |
dot git-diff | Diff / repo watcher view across managed repos. |
dot git-status | Branch status for the current repo (agent context). |
dot omarchy | Open the Omarchy desktop controls menu. |
See the full Command Reference for every subcommand and flag.
Source of truth
Section titled “Source of truth”Command and flag metadata lives in dot/src/cli/spec.ts. Help rendering, shell completions, and the generated Command Reference all read from that one registry, so they never drift. When a command changes, the reference page is regenerated from spec.ts.