Skip to content

Commit 904a7d1

Browse files
PaulDuvallclaude
andcommitted
docs: update README with npm scoped package and new features
📋 Change summary: * Updated package name to @paulduvall/claude-dev-toolkit * Added configuration command documentation and usage examples * Documented subagents support and multi-agent coordination * Enhanced CLI usage section with config management commands * Added version 0.0.1-alpha.2 changelog and feature updates * Updated test suite documentation to include config and subagents tests 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 75f03b1 commit 904a7d1

File tree

1 file changed

+41
-5
lines changed

1 file changed

+41
-5
lines changed

claude-dev-toolkit/README.md

Lines changed: 41 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Claude Dev Toolkit
22

3-
[![npm version](https://badge.fury.io/js/claude-dev-toolkit.svg)](https://www.npmjs.com/package/claude-dev-toolkit)
3+
[![npm version](https://badge.fury.io/js/%40paulduvall%2Fclaude-dev-toolkit.svg)](https://www.npmjs.com/package/@paulduvall/claude-dev-toolkit)
44
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
55
![Test Status](https://img.shields.io/badge/tests-100%25%20passing-brightgreen)
66
![Active Commands](https://img.shields.io/badge/active%20commands-13-blue)
@@ -13,7 +13,7 @@
1313

1414
```bash
1515
# Install globally via NPM
16-
npm install -g claude-dev-toolkit
16+
npm install -g @paulduvall/claude-dev-toolkit
1717

1818
# Commands are immediately available in Claude Code
1919
claude
@@ -33,7 +33,7 @@ claude
3333

3434
### Option 1: Automatic Setup (Recommended)
3535
```bash
36-
npm install -g claude-dev-toolkit
36+
npm install -g @paulduvall/claude-dev-toolkit
3737
# Interactive setup wizard runs automatically
3838
```
3939

@@ -81,6 +81,7 @@ Advanced commands for specialized workflows:
8181
- **Compliance**: `/xcompliance`, `/xgovernance`, `/xpolicy`
8282
- **Advanced Security**: `/xred`, `/xrisk`, `/xscan`
8383
- **Performance**: `/xperformance`, `/xoptimize`
84+
- **Subagents**: `/xsubagents` - Multi-agent coordination and task delegation
8485

8586
## 🛠️ CLI Usage
8687

@@ -92,29 +93,53 @@ claude-commands install --active # Install production commands
9293
claude-commands install --experimental # Install experimental commands
9394
claude-commands install --all # Install all commands
9495

96+
# Configuration Management
97+
claude-commands config --list # List available templates
98+
claude-commands config --template <name> # Apply configuration template
99+
claude-commands config --help # Show config command help
100+
95101
# In Claude Code
96102
/xhelp # Show command help
97103
/xtest # Run intelligent test suite
98104
/xquality fix # Auto-fix code quality issues
99105
/xsecurity --scan --report # Comprehensive security scan
100106
/xgit # Automated git workflow
107+
/xsubagents --create teamlead # Create specialized subagent
101108
```
102109

103110
## 🔧 Configuration
104111

112+
### Configuration Management
113+
114+
Use the built-in config command to manage Claude Code settings:
115+
116+
```bash
117+
# List available configuration templates
118+
claude-commands config --list
119+
120+
# Apply a specific template
121+
claude-commands config --template basic-settings.json
122+
claude-commands config --template security-focused-settings.json
123+
claude-commands config --template comprehensive-settings.json
124+
125+
# Show help for config command
126+
claude-commands config --help
127+
```
128+
105129
### Installation Locations
106130
- **Commands**: `~/.claude/commands/active/` and `~/.claude/commands/experiments/`
107131
- **Configuration**: `~/.claude/settings.json`
108132
- **Security Hooks**: `~/.claude/hooks/`
133+
- **Templates**: Bundled with package installation
109134

110135
### Configuration Templates
111136
The package includes three pre-configured templates:
112137

113138
1. **Basic** (`basic-settings.json`): Minimal setup for command functionality
114-
2. **Security-Focused** (`security-focused-settings.json`): Enhanced security with hooks
139+
2. **Security-Focused** (`security-focused-settings.json`): Enhanced security with hooks
115140
3. **Comprehensive** (`comprehensive-settings.json`): Full feature set with governance
116141

117-
Templates are automatically applied during interactive setup or can be manually copied to `~/.claude/settings.json`.
142+
Templates are applied via the config command with automatic backup of existing settings.
118143

119144
## 🧪 Development & Testing
120145

@@ -127,6 +152,8 @@ npm test
127152
npm run test:commands # Command validation
128153
npm run test:workflow # Core workflow tests
129154
npm run test:security # Security command tests
155+
npm run test:config # Configuration command tests
156+
npm run test:subagents # Subagents command tests
130157
npm run test:req007 # Interactive setup wizard
131158
npm run test:req009 # Configuration templates
132159
npm run test:req018 # Security hook installation
@@ -204,6 +231,8 @@ Every command includes built-in help:
204231
/xtest help # Show all testing options
205232
/xquality help # Show quality check options
206233
/xsecurity help # Show security scanning options
234+
/xconfig help # Show configuration options
235+
/xsubagents help # Show subagent management options
207236
```
208237

209238
## 🤝 Contributing
@@ -233,6 +262,13 @@ npm test
233262

234263
## 🔄 Recent Updates
235264

265+
### Version 0.0.1-alpha.2
266+
-**NPM Scoped Package**: Published as `@paulduvall/claude-dev-toolkit`
267+
-**Configuration Command**: Built-in `config` command for template management
268+
-**Workflow Reporting**: Comprehensive GitHub Actions reporting
269+
-**Subagents Support**: Multi-agent coordination capabilities
270+
-**Enhanced Documentation**: Updated installation and usage instructions
271+
236272
### Version 0.0.1-alpha.1
237273
-**Symlink Consolidation**: Eliminated duplicate directories
238274
-**JavaScript Migration**: Complete test suite migration from Python

0 commit comments

Comments
 (0)