@heyitsiveen/dotfiles 1.0.4 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -21,17 +21,19 @@ Interactive CLI to set up dotfiles for macOS and Windows 11. One command to inst
21
21
  ## Quick Start
22
22
 
23
23
  ```bash
24
- bunx @heyitsiveen/dotfiles@latest
24
+ npx @heyitsiveen/dotfiles@latest
25
25
  ```
26
26
 
27
27
  Or with other package runners:
28
28
 
29
29
  ```bash
30
- npx @heyitsiveen/dotfiles@latest
30
+ bunx @heyitsiveen/dotfiles@latest
31
31
  pnpm dlx @heyitsiveen/dotfiles@latest
32
32
  yarn dlx @heyitsiveen/dotfiles@latest
33
33
  ```
34
34
 
35
+ > **This CLI modifies your home directory.** It writes to `~/.config/`, `~/.zshrc` (macOS) or PowerShell profile (Windows), and other tool-specific paths. **Existing configs are backed up to `~/.config/heyitsiveen/dotfiles/backup/` before any overwrite.** Preview with `--dry-run` first. Undo with `--restore` or `--uninstall`.
36
+
35
37
  ## Prerequisites
36
38
 
37
39
  | Prerequisite | Why | Install |
@@ -99,6 +101,8 @@ The CLI automatically detects all tools and offers to install missing ones via H
99
101
  | ripgrep | Search config |
100
102
  | Claude Code | 6 MCP servers, CLAUDE.md, settings |
101
103
 
104
+ > ⚠️ **Claude Code configs are the author's personal setup.** `settings.json` enables specific plugins, sets `effortLevel: xhigh`, `advisorModel: opus`, and skips dangerous-mode permission prompts. `.claude.json` wires three MCP servers (exa, grep, better-auth). `CLAUDE.md` is the author's 13-rule instruction set. If you prefer defaults, **deselect "Claude Code"** when the CLI asks which configs to install — or replace the files in `~/.claude/` after install.
105
+
102
106
  ## Color Themes
103
107
 
104
108
  Three themes are available across all tools:
@@ -151,20 +155,20 @@ Subsequent runs detect the existing installation and offer:
151
155
  ## Development
152
156
 
153
157
  ```bash
154
- # Install dependencies (bun is the primary package manager)
155
- bun install
158
+ # Install dependencies
159
+ npm install
156
160
 
157
161
  # Build
158
- bun run build
162
+ npm run build
159
163
 
160
164
  # Run locally
161
165
  node dist/index.mjs
162
166
 
163
167
  # Run all checks (typecheck + lint + format)
164
- bun run check
168
+ npm run check
165
169
 
166
- # Or with npm
167
- npm install && npm run build && npm run check
170
+ # Or with bun
171
+ bun install && bun run build && bun run check
168
172
  ```
169
173
 
170
174
  **Pre-commit hooks** are set up via [husky](https://typicode.github.io/husky/) + [lint-staged](https://github.com/lint-staged/lint-staged). Every `git commit` automatically: