Clone the repository to ~/.dotfiles.
git clone https://github.com/jinyongp/dotfiles.git ~/.dotfilesRun the interactive installer.
~/.dotfiles/installRun a single target directly when you only want one part of the setup.
~/.dotfiles/install neovim
~/.dotfiles/install packages fnm eza
~/.dotfiles/install themeThe interactive installer is plan-first: it starts with a profile (Minimal, Recommended, Full, or Custom), then lets you review, revise, or cancel the final plan before anything runs.
For the full interactive flow, direct install targets, platform notes, and machine-local config paths, see docs/installer.md.
This repo treats Neovim as the primary terminal editor. The dotfiles setup links the repo-managed Neovim config and keeps plain Vim as a lightweight fallback.
For editor behavior and formatting rules, see docs/editor.md.
For the keymap reference, see docs/neovim-keymaps.md.
- Local shell override paths are documented in
docs/installer.md. Secrets should not be committed into the repository. - Installer-written machine-local Git files are documented in
docs/installer.md. - Commit message rules are documented in
docs/contributing.md.