@heyitsiveen/dotfiles 1.0.3 → 1.1.0

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
@@ -5,6 +5,7 @@ Interactive CLI to set up dotfiles for macOS and Windows 11. One command to inst
5
5
  <!-- TODO: Replace with actual recording -->
6
6
  <!-- ![Demo](docs/demo.gif) -->
7
7
  <!-- [How to record the demo GIF](docs/recording-demo.md) -->
8
+ ![Demo](assets/demo.gif)
8
9
 
9
10
  ## Table of Contents
10
11
 
@@ -20,17 +21,19 @@ Interactive CLI to set up dotfiles for macOS and Windows 11. One command to inst
20
21
  ## Quick Start
21
22
 
22
23
  ```bash
23
- bunx @heyitsiveen/dotfiles@latest
24
+ npx @heyitsiveen/dotfiles@latest
24
25
  ```
25
26
 
26
27
  Or with other package runners:
27
28
 
28
29
  ```bash
29
- npx @heyitsiveen/dotfiles@latest
30
+ bunx @heyitsiveen/dotfiles@latest
30
31
  pnpm dlx @heyitsiveen/dotfiles@latest
31
32
  yarn dlx @heyitsiveen/dotfiles@latest
32
33
  ```
33
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
+
34
37
  ## Prerequisites
35
38
 
36
39
  | Prerequisite | Why | Install |
@@ -98,6 +101,8 @@ The CLI automatically detects all tools and offers to install missing ones via H
98
101
  | ripgrep | Search config |
99
102
  | Claude Code | 6 MCP servers, CLAUDE.md, settings |
100
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
+
101
106
  ## Color Themes
102
107
 
103
108
  Three themes are available across all tools:
@@ -150,20 +155,20 @@ Subsequent runs detect the existing installation and offer:
150
155
  ## Development
151
156
 
152
157
  ```bash
153
- # Install dependencies (bun is the primary package manager)
154
- bun install
158
+ # Install dependencies
159
+ npm install
155
160
 
156
161
  # Build
157
- bun run build
162
+ npm run build
158
163
 
159
164
  # Run locally
160
165
  node dist/index.mjs
161
166
 
162
167
  # Run all checks (typecheck + lint + format)
163
- bun run check
168
+ npm run check
164
169
 
165
- # Or with npm
166
- npm install && npm run build && npm run check
170
+ # Or with bun
171
+ bun install && bun run build && bun run check
167
172
  ```
168
173
 
169
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: