Skip to content

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.

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

OptionDescription
--confirmAcknowledge non-interactive package helpers
--noninteractiveSkip interactive prompts for this run
--interactiveAllow 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

Terminal window
dot init --noninteractive --confirm
dot init --host laptop --noninteractive --confirm
dot init --branch main --bootstrap-branch distro/omarchy

Ensure prerequisites, then backup/adopt dotfiles

dot install

Pull repos, stow dotfiles, install deps, rebuild

dot update

Options

OptionDescription
--pullPull repos only
--stowStow only
--tuiInstall deps and rebuild dot binary only
--checkReport core/system repos behind upstream (no update); exit 10 if any
--check-allReport all tracked repos behind upstream (no update); exit 10 if any

Re-stow public/private dotfiles

dot stow

Options

OptionDescription
--publicStow public dotfiles only
--privateStow private dotfiles only

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

OptionDescription
--open-opencodeSave report and open it in OpenCode

Checks performed

Dependencies Required/optional CLI tools (git, stow, gh, gum, ...)
Secret Service kwallet vs gnome-keyring provider
Repositories Public/private dotfiles + private git repos exist and have upstreams
Origin HEAD Local origin/HEAD tracks the remote default branch (not stale)
Stow integrity Dry-run restow to detect drift
OpenCode location Canonical paths, legacy remnants
Git config Managed include is active
Workflow runs Repo list, status bar config, legacy watcher cleanup
Git notifications API scope and status bar notification module wiring
Doctor startup Startup notification timer
Daily volume reset Laptop-only optional timer
Omarchy repos Diff repos + worktree branch correctness
Legacy Hypr repo Flags a retired omarchy-hypr clone at ~/.config/hypr
Browser flags Symlinks from private stow package
Hardware video VAAPI render nodes, drivers, packages
Browser extensions Private extension check list
Public packages AUR packages installed + version check
Private packages Private repo + packages installed
Pacman hooks Hook files installed and up to date

Exit codes

0 No critical errors (warnings may still be present)
1 One or more critical errors found

Examples

Terminal window
dot doctor
dot doctor --open-opencode

Unstow managed dotfiles

dot clean

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 rows

Options

OptionDescription
--no-fetchSkip fetching from remotes (use local refs only)
--tab <tab>Initial pane to focus in TUI (default: changed) (one of: changed, other, unchanged)
--rawText summary output
--bar-jsonJSON output for status bars and shell modules
--list-changedChanged repos as rows
--list-allAll tracked repos as rows

Examples

Terminal window
dot git-diff
dot git-diff --raw
dot git-diff --bar-json
dot git-diff --tab other

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 branch

Options

OptionDescription
--diffAppend full unstaged and staged diffs for changed files
--branch-diffAppend the merge-base diff vs the default branch (errors on the default branch)

Examples

Terminal window
dot git-status
dot git-status --diff
dot git-status --branch-diff
dot git-status --diff --branch-diff

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 commits

Options

OptionDescription
--rawText summary of recent commits

Examples

Terminal window
dot git-log
dot git-log --raw

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 rows

Options

OptionDescription
--since <date>Only include runs active at or after this date (ISO/RFC/epoch)
--rawText summary of watched workflow runs
--bar-jsonJSON output for status bars and shell modules
--list-reposWatched repo summaries as rows
--list-runsWorkflow runs as rows

Examples

Terminal window
dot git-workflows
dot git-workflows --raw
dot git-workflows --bar-json
dot git-workflows --since "$(date -u -d '1 hour ago' +%Y-%m-%dT%H:%M:%SZ)"
dot git-workflows --list-runs

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 output

Options

OptionDescription
--rawText summary of notification threads
--bar-jsonJSON output for status bars and shell modules
--list-threadsNotification threads as rows
--bar-filterApply watched-repo filtering in raw/list output
--allInclude read notifications
--participatingOnly 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-readMark unread Renovate/Dependabot/bot notifications as read
--dry-runPreview —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

Terminal window
dot git-notifications
dot git-notifications --bar-json
dot git-notifications --participating
dot git-notifications --mark-bot-read --dry-run
dot git-notifications --mark-read 12345

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 repos

Options

OptionDescription
--allShow notes from every repo-notes directory

Examples

Terminal window
dot notes
dot notes --all
dot notes root
dot notes context --command notes-list
dot notes list --all
dot notes list --format json

Print the notes vault root

dot notes root

Options

OptionDescription
--repo-notesPrint repository notes directory

Print the context block for OpenCode notes

dot notes context

Options

OptionDescription
--command <name>OpenCode command name

List repository notes

dot notes list

Options

OptionDescription
--allShow notes from every repo-notes directory
--format `<labelsjson>`

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

OptionDescription
--allShow handoff notes from every repo-notes directory
--listList handoff notes to stdout without opening the TUI

Aliases

dot handoff
dot handoffs

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

Terminal window
dot note read --path ~/Documents/notes/repo-notes/owner/repo/topic.md
dot note write --path /tmp/notes/repo-notes/owner/repo/topic.md --stdin
dot note delete --path /tmp/notes/repo-notes/owner/repo/topic.md

Print a note file

dot note read

Options

OptionDescription
--path <path>Note file path

Write stdin to a note file and commit it

dot note write

Options

OptionDescription
--path <path>Note file path
--stdinRead note content from stdin

Delete a note file and commit it

dot note delete

Options

OptionDescription
--path <path>Note file path

Sync AGENTS.md to Cursor rule

dot agents-sync

Debug OpenCode config and paths

dot opencode-debug

Options

OptionDescription
--agent <name>Debug a specific OpenCode agent

Register private pacman repo include

dot setup-private-repo

Sync 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

Terminal window
dot setup-private-repo

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

OptionDescription
--no-gitSkip package repo commit and push
--skip-buildPublish an existing dist package artifact
--installInstall the published package after syncing the mirror

Arguments

ArgumentDescription
<package-name>

Examples

Terminal window
dot private-pkg-publish twitch-notifications --install
dot private-pkg-publish --skip-build --no-git twitch-notifications

Check/apply imported skill updates

dot skill-updates

Options

OptionDescription
--checkCheck only without applying
--updateAuto-apply clean updates
--skip-reviewSkip local-edit review

Validate skill references

dot skill-check

Options

OptionDescription
--open-opencodeRun checks then open OpenCode analysis
--diff-originDiff imported skills against their upstream origins; with —open-opencode, include the diff in the prompt

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

OptionDescription
--stdoutPrint the completion script instead of writing it

Arguments

ArgumentDescription
<shell>One of: zsh.

Examples

Terminal window
dot completions zsh
dot completions zsh --stdout

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

ArgumentDescription
<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 management
font Font management
toggle Toggle system features
capture Screenshots and recordings
system Lock, logout, reboot, shutdown
launch Launch applications
refresh Refresh system components
restart Restart system services
install Install software and tools
remove Remove software and features
packages Package management
share Share clipboard, files, folders
reminder Reminders
setup DNS, security setup
snapshot System snapshots
brightness Display and keyboard brightness
power Power profiles

Show this help menu

dot help