Skip to content

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 dot with 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.
CommandWhat it does
dot initOne-time first-use setup for a fresh machine.
dot updateSelf-update, install deps, rebuild, pull, stow, restart.
dot stowStow refresh only (no git pull).
dot doctorRun dotfiles system health checks.
dot git-diffDiff / repo watcher view across managed repos.
dot git-statusBranch status for the current repo (agent context).
dot omarchyOpen the Omarchy desktop controls menu.

See the full Command Reference for every subcommand and flag.

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.