Command Reference
This page lists every dot command, generated from the same registry that powers dot help and shell completions. Run any command with --help to see the same details at the terminal.
dot init
Section titled “dot init”Run one-time first-use machine setup
dot init [options]Run the one-time first-use setup workflow for a fresh machine. Init prepares repos, stow links, mise tools, packages, machine hooks, and then finishes by running dot update. After init completes, use dot update for ongoing maintenance.
Options
| Option | Description |
|---|---|
--confirm | Acknowledge non-interactive package helpers |
--noninteractive | Skip interactive prompts for this run |
--interactive | Allow interactive prompts for this run |
--host <name> | Hypr host to link before stow (default: OMARCHY_HOST or desktop) (one of: desktop, laptop) |
--log <path> | Init log path (default: /tmp/dot-init.log) |
--branch <name> | Branch override for non-bootstrap Omarchy repos |
--bootstrap-branch <name> | Branch override for bootstrap |
Examples
dot init --noninteractive --confirmdot init --host laptop --noninteractive --confirmdot init --branch main --bootstrap-branch distro/omarchydot install
Section titled “dot install”Ensure prerequisites, then backup/adopt dotfiles
dot installdot update
Section titled “dot update”Pull repos, stow dotfiles, install deps, rebuild
dot updateOptions
| Option | Description |
|---|---|
--pull | Pull repos only |
--stow | Stow only |
--tui | Install deps and rebuild dot binary only |
--check | Report core/system repos behind upstream (no update); exit 10 if any |
--check-all | Report all tracked repos behind upstream (no update); exit 10 if any |
dot stow
Section titled “dot stow”Re-stow public/private dotfiles
dot stowOptions
| Option | Description |
|---|---|
--public | Stow public dotfiles only |
--private | Stow private dotfiles only |
dot doctor
Section titled “dot doctor”Run dotfiles system health checks
dot doctor [options]Run health checks on the dotfiles system. Verifies dependencies, repos, stow integrity, systemd timers, packages, browser config, and more.
All checks run in parallel. Results are printed per-section with a grouped summary at the end. A log file is always written to ~/.local/state/dot/logs/.
Options
| Option | Description |
|---|---|
--open-opencode | Save report and open it in OpenCode |
Checks performed
Dependencies Required/optional CLI tools (git, stow, gh, gum, ...)Secret Service kwallet vs gnome-keyring providerRepositories Public/private dotfiles + private git repos exist and have upstreamsOrigin HEAD Local origin/HEAD tracks the remote default branch (not stale)Stow integrity Dry-run restow to detect driftOpenCode location Canonical paths, legacy remnantsGit config Managed include is activeWorkflow runs Repo list, status bar config, legacy watcher cleanupGit notifications API scope and status bar notification module wiringDoctor startup Startup notification timerDaily volume reset Laptop-only optional timerOmarchy repos Diff repos + worktree branch correctnessLegacy Hypr repo Flags a retired omarchy-hypr clone at ~/.config/hyprBrowser flags Symlinks from private stow packageHardware video VAAPI render nodes, drivers, packagesBrowser extensions Private extension check listPublic packages AUR packages installed + version checkPrivate packages Private repo + packages installedPacman hooks Hook files installed and up to dateExit codes
0 No critical errors (warnings may still be present)1 One or more critical errors foundExamples
dot doctordot doctor --open-opencodedot clean
Section titled “dot clean”Unstow managed dotfiles
dot cleandot git-diff
Section titled “dot git-diff”Aliases: dot diff
Open the git diff/repo watcher view
dot git-diff [options]Open the diff/repo watcher view. Without flags, opens the interactive TUI.
Modes
(default) Interactive TUI diff view--raw Text summary of repos with changes--bar-json JSON output for status bars and shell modules--list-changed Changed repos as name|path rows--list-all All tracked repos as name|path rowsOptions
| Option | Description |
|---|---|
--no-fetch | Skip fetching from remotes (use local refs only) |
--tab <tab> | Initial pane to focus in TUI (default: changed) (one of: changed, other, unchanged) |
--raw | Text summary output |
--bar-json | JSON output for status bars and shell modules |
--list-changed | Changed repos as rows |
--list-all | All tracked repos as rows |
Examples
dot git-diffdot git-diff --rawdot git-diff --bar-jsondot git-diff --tab otherdot git-status
Section titled “dot git-status”Show branch status for the current repository
dot git-status [options]Print unstaged files, staged files, and the last 10 commits — each with a compact relative timestamp, a pushed/local remote marker, and its changed files inline with (+added -deleted) line counts — for the current git repository. Designed as a single command for agents to get full working-tree and branch context.
Substitutes running these separately: git status, git diff —stat / git diff —numstat, git diff —cached —stat, git log —oneline —stat, and git log @{upstream}..HEAD (ahead/pushed check).
Add —diff to append the full unstaged and staged diffs under their sections, and —branch-diff to append the full diff of the current branch against the default branch (measured from their merge base so committed and uncommitted changes both show). —branch-diff errors on the default branch, where that range is empty. The flags combine.
Modes
(default) Status summary: unstaged, staged, recent commits--diff Also print full unstaged and staged diffs--branch-diff Also print the full diff vs the default branchOptions
| Option | Description |
|---|---|
--diff | Append full unstaged and staged diffs for changed files |
--branch-diff | Append the merge-base diff vs the default branch (errors on the default branch) |
Examples
dot git-statusdot git-status --diffdot git-status --branch-diffdot git-status --diff --branch-diffdot git-log
Section titled “dot git-log”Open recent commits across tracked repos
dot git-log [options]Open the recent commit history view. The left pane lists tracked repositories from dot git-diff, sorted by latest commit activity. The right pane lists recent commits for the selected repository.
Modes
(default) Interactive git log TUI--raw Text summary of recent commitsOptions
| Option | Description |
|---|---|
--raw | Text summary of recent commits |
Examples
dot git-logdot git-log --rawdot git-workflows
Section titled “dot git-workflows”Open watched GitHub workflow runs
dot git-workflows [options]Open the watched GitHub workflow runs view. The left pane lists watched repositories from the private repo list. The right pane lists runs for the selected repo’s locally checked-out HEAD commit.
Modes
(default) Interactive workflow runs TUI--raw Text summary of watched workflow runs--bar-json JSON output for status bars and shell modules--list-repos Watched repo summaries as rows--list-runs Workflow runs as rowsOptions
| Option | Description |
|---|---|
--since <date> | Only include runs active at or after this date (ISO/RFC/epoch) |
--raw | Text summary of watched workflow runs |
--bar-json | JSON output for status bars and shell modules |
--list-repos | Watched repo summaries as rows |
--list-runs | Workflow runs as rows |
Examples
dot git-workflowsdot git-workflows --rawdot git-workflows --bar-jsondot git-workflows --since "$(date -u -d '1 hour ago' +%Y-%m-%dT%H:%M:%SZ)"dot git-workflows --list-runsdot git-notifications
Section titled “dot git-notifications”Open GitHub notification inbox
dot git-notifications [options]Open the authenticated user’s GitHub notification inbox. Without machine or action flags, opens the interactive TUI.
Modes
(default) Interactive notifications TUI--raw Text summary of notification threads--bar-json JSON output for status bars and shell modules--list-threads Notification threads as rows--bar-filter Apply watched-repo filtering in raw/list outputOptions
| Option | Description |
|---|---|
--raw | Text summary of notification threads |
--bar-json | JSON output for status bars and shell modules |
--list-threads | Notification threads as rows |
--bar-filter | Apply watched-repo filtering in raw/list output |
--all | Include read notifications |
--participating | Only include participating or mentioned threads |
--since <date> | Only include notifications updated after this date |
--mark-read <id> | Mark a notification thread as read |
--mark-bot-read | Mark unread Renovate/Dependabot/bot notifications as read |
--dry-run | Preview —mark-bot-read without mutating GitHub state |
--mark-done <id> | Mark a notification thread as done |
--ignore <id> | Ignore future notifications for a thread |
--unignore <id> | Stop ignoring future notifications for a thread |
Examples
dot git-notificationsdot git-notifications --bar-jsondot git-notifications --participatingdot git-notifications --mark-bot-read --dry-rundot git-notifications --mark-read 12345dot notes
Section titled “dot notes”Open repository notes or run note utility commands
dot notes [--all] [command] [options]Manage repository notes used by OpenCode note commands.
Modes
(default) Interactive notes TUI--all Interactive notes TUI across all reposOptions
| Option | Description |
|---|---|
--all | Show notes from every repo-notes directory |
Examples
dot notesdot notes --alldot notes rootdot notes context --command notes-listdot notes list --alldot notes list --format jsondot notes root
Section titled “dot notes root”Print the notes vault root
dot notes rootOptions
| Option | Description |
|---|---|
--repo-notes | Print repository notes directory |
dot notes context
Section titled “dot notes context”Print the context block for OpenCode notes
dot notes contextOptions
| Option | Description |
|---|---|
--command <name> | OpenCode command name |
dot notes list
Section titled “dot notes list”List repository notes
dot notes listOptions
| Option | Description |
|---|---|
--all | Show notes from every repo-notes directory |
--format `<labels | json>` |
dot handoffs
Section titled “dot handoffs”Aliases: dot handoff
Open handoff notes
dot handoffs [--all] [--list]Open the interactive notes TUI filtered to notes tagged handoff. Use —list for a plain text listing without the TUI.
Options
| Option | Description |
|---|---|
--all | Show handoff notes from every repo-notes directory |
--list | List handoff notes to stdout without opening the TUI |
Aliases
dot handoffdot handoffsdot note
Section titled “dot note”Read, write, or delete note files
dot note <command> [options]Read, write, and delete note files. Writes and deletes are committed to the notes vault when possible.
Examples
dot note read --path ~/Documents/notes/repo-notes/owner/repo/topic.mddot note write --path /tmp/notes/repo-notes/owner/repo/topic.md --stdindot note delete --path /tmp/notes/repo-notes/owner/repo/topic.mddot note read
Section titled “dot note read”Print a note file
dot note readOptions
| Option | Description |
|---|---|
--path <path> | Note file path |
dot note write
Section titled “dot note write”Write stdin to a note file and commit it
dot note writeOptions
| Option | Description |
|---|---|
--path <path> | Note file path |
--stdin | Read note content from stdin |
dot note delete
Section titled “dot note delete”Delete a note file and commit it
dot note deleteOptions
| Option | Description |
|---|---|
--path <path> | Note file path |
dot agents-sync
Section titled “dot agents-sync”Sync AGENTS.md to Cursor rule
dot agents-syncdot opencode-debug
Section titled “dot opencode-debug”Debug OpenCode config and paths
dot opencode-debugOptions
| Option | Description |
|---|---|
--agent <name> | Debug a specific OpenCode agent |
dot setup-private-repo
Section titled “dot setup-private-repo”Register private pacman repo include
dot setup-private-repoSync the private Arch package repo mirror, write the private pacman repo snippet, and add the Include line to /etc/pacman.conf when it is missing.
This repairs Omarchy pacman.conf refreshes that remove local repository includes. Privileged writes prefer pkexec and fall back to sudo.
Examples
dot setup-private-repodot private-pkg-publish
Section titled “dot private-pkg-publish”Build and publish a private package
dot private-pkg-publish [options] <package-name>Build and publish a mapped private package into the private pacman repo.
Options
| Option | Description |
|---|---|
--no-git | Skip package repo commit and push |
--skip-build | Publish an existing dist package artifact |
--install | Install the published package after syncing the mirror |
Arguments
| Argument | Description |
|---|---|
<package-name> |
Examples
dot private-pkg-publish twitch-notifications --installdot private-pkg-publish --skip-build --no-git twitch-notificationsdot skill-updates
Section titled “dot skill-updates”Check/apply imported skill updates
dot skill-updatesOptions
| Option | Description |
|---|---|
--check | Check only without applying |
--update | Auto-apply clean updates |
--skip-review | Skip local-edit review |
dot skill-check
Section titled “dot skill-check”Validate skill references
dot skill-checkOptions
| Option | Description |
|---|---|
--open-opencode | Run checks then open OpenCode analysis |
--diff-origin | Diff imported skills against their upstream origins; with —open-opencode, include the diff in the prompt |
dot completions
Section titled “dot completions”Generate shell completions
dot completions [zsh] [--stdout]Generate shell completions for dot.
By default this writes the managed Zsh completion file in the public dotfiles repo so the next dot stow installs it to ~/.local/share/zsh/site-functions/_dot.
Options
| Option | Description |
|---|---|
--stdout | Print the completion script instead of writing it |
Arguments
| Argument | Description |
|---|---|
<shell> | One of: zsh. |
Examples
dot completions zshdot completions zsh --stdoutdot omarchy
Section titled “dot omarchy”Open an Omarchy submenu by path
dot omarchy [submenu...]Open the Omarchy desktop controls menu. Pass a submenu path to jump straight to it:
dot omarchy theme Theme submenu dot omarchy theme set Execute theme set directly
Arguments
| Argument | Description |
|---|---|
<submenu> | Repeatable. One of: theme, font, toggle, capture, system, launch, refresh, restart, install, remove, packages, share, reminder, setup, snapshot, brightness, power. |
Available submenus
theme Theme managementfont Font managementtoggle Toggle system featurescapture Screenshots and recordingssystem Lock, logout, reboot, shutdownlaunch Launch applicationsrefresh Refresh system componentsrestart Restart system servicesinstall Install software and toolsremove Remove software and featurespackages Package managementshare Share clipboard, files, foldersreminder Reminderssetup DNS, security setupsnapshot System snapshotsbrightness Display and keyboard brightnesspower Power profilesdot help
Section titled “dot help”Show this help menu
dot help