@dottyfiles/cli
v0.1.0
Published
Main CLI binary for dotty - a beautiful CLI for managing dotfiles on macOS.
Readme
@dottyfiles/cli
Main CLI binary for dotty - a beautiful CLI for managing dotfiles on macOS.
Installation
npm install -g @dottyfiles/cliUsage
dotty # Interactive menu
dotty status # Show dotfiles status
dotty sync # Pull and apply changes
dotty diff # Preview pending changes
dotty apply # Apply dotfiles to system
dotty doctor # Check system health
dotty edit <file> # Edit a dotfile
dotty add <file> # Add a file to dotfilesGlobal Options
| Option | Description |
|--------|-------------|
| -y, --yes | Skip confirmation prompts |
| --dry-run | Show what would be done without doing it |
| -V, --version | Output version number |
| -h, --help | Display help |
Commands
dotty (no subcommand)
Opens an interactive menu to select an action.
dotty status
Shows the status of your dotfiles including:
- Pending file changes
- Run scripts to execute
- Git status of dotfiles repo
dotty sync
Pulls changes from remote and applies them. Equivalent to chezmoi update.
dotty diff
Shows a diff of pending changes before applying.
dotty apply
Applies all pending dotfile changes to your system.
dotty doctor
Checks system health and dependencies:
- Core tools: brew, chezmoi, git, node, pnpm
- Optional tools: dockutil, mas
- Directories: dotfiles, chezmoi source, TPM, zsh plugins
- Package version consistency
dotty edit <file>
Opens a managed dotfile in your editor via chezmoi.
dotty add <file>
Adds a new file to dotfiles management.
Requirements
- Node.js 18+
- macOS (for full functionality)
- chezmoi (for dotfile management)
- Homebrew (optional, for brew operations)
- mas (optional, for Mac App Store operations)
Related Packages
- @dottyfiles/core - Shared utilities
- @dottyfiles/chezmoi - Chezmoi wrapper
- @dottyfiles/homebrew - Homebrew integration
- @dottyfiles/mas - Mac App Store integration
License
MIT
