@ngxtm/devkit 1.0.0 → 2.0.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
@@ -32,11 +32,67 @@ npm install -g @ngxtm/devkit
32
32
  devkit install
33
33
  ```
34
34
 
35
- ### Install to specific tool only
35
+ ### Install Modes
36
+
37
+ | Mode | Command | Skills Size | Description |
38
+ |------|---------|-------------|-------------|
39
+ | **Index-only** (default) | `devkit install` | ~30KB | Only installs skills index, Claude loads skills on-demand |
40
+ | Minimal | `devkit install --minimal` | ~2MB | Installs ~20 core skills |
41
+ | Category | `devkit install -c=react` | varies | Installs specific categories |
42
+ | Full | `devkit install --full` | ~59MB | Installs all 413+ skills (may cause context limit) |
36
43
 
37
44
  ```bash
38
- devkit install claude # Claude Code only
39
- devkit install cursor # Cursor only
45
+ # Recommended: Index-only (default)
46
+ devkit install # Best for avoiding context limits
47
+ devkit install claude # Claude Code only
48
+
49
+ # Alternative modes
50
+ devkit install --minimal # ~20 core skills
51
+ devkit install --category=react,ts # Specific categories
52
+ devkit install --full # All skills (large)
53
+ devkit install --interactive # Choose interactively
54
+ ```
55
+
56
+ ### How Index-Only Mode Works
57
+
58
+ Instead of installing 3,500+ files (59MB), devkit installs:
59
+ - `SKILLS_INDEX.md` - 30KB summary of all 411 skills
60
+ - All commands (`/plan`, `/cook`, `/brainstorm`, etc.)
61
+ - All agents (planner, debugger, reviewer, etc.)
62
+ - Hooks, rules, output-styles
63
+
64
+ When Claude needs a specific skill, it reads the index to find it, then loads the full skill on-demand. This reduces context usage by **99.95%**.
65
+
66
+ ### Available Categories
67
+
68
+ ```bash
69
+ devkit categories # Show all categories
70
+ ```
71
+
72
+ | Category | Skills | Description |
73
+ |----------|--------|-------------|
74
+ | react | 9 | React, Next.js, Remix |
75
+ | typescript | 4 | TypeScript patterns |
76
+ | node | 6 | Node.js, NestJS, Express |
77
+ | database | 5 | PostgreSQL, MongoDB, Redis |
78
+ | devops | 7 | Docker, K8s, CI/CD, AWS |
79
+ | testing | 6 | Jest, Playwright, Vitest |
80
+ | security | 5 | OWASP, Auth, API security |
81
+ | ai | 6 | AI agents, MCP, prompts |
82
+ | mobile | 5 | React Native, Flutter |
83
+ | frontend | 6 | CSS, Tailwind, a11y |
84
+ | backend | 6 | APIs, microservices |
85
+ | tools | 6 | Git, debugging, docs |
86
+
87
+ ## Uninstallation
88
+
89
+ ```bash
90
+ # Remove from all tools
91
+ devkit uninstall
92
+
93
+ # Remove from specific tool
94
+ devkit uninstall claude
95
+ devkit uninstall cursor
40
96
  ```
41
97
 
42
98
  ## What Gets Installed