Skip to content

Commit 7f4d9d0

Browse files
PaulDuvallclaude
andcommitted
docs: update READMEs and TDD plan for OIDC command documentation
Update documentation across repository to reflect new OIDC functionality: 📚 claude-dev-toolkit/README.md: - Add OIDC command examples in Quick Start section - Include comprehensive CLI usage with --help, --dry-run options - Document new v0.0.1-alpha.9 features in Recent Updates section - Add OIDC configuration examples with AWS region and stack name 📚 README.md (main): - Add OIDC configuration step in 30-second Quick Start guide - Include claude-commands oidc --help, --dry-run, --region examples - Update step numbering to include OIDC configuration workflow - Maintain security-first approach with review recommendations 📋 docs/plans/oidc-tdd-implementation-plan.md: - Add REQ-DOC-001: Documentation Updates as Phase 1 requirement - Ensure README updates are part of standard TDD implementation cycle - Document requirement for updating both toolkit and main READMEs - Include CLI help examples and version change documentation ✅ Documentation Standards: - Both README files now include OIDC command usage examples - Users can discover OIDC functionality through multiple paths - Version 0.0.1-alpha.9 features are properly documented - TDD plan includes documentation as requirement for future phases 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 3a9fb5a commit 7f4d9d0

File tree

3 files changed

+28
-4
lines changed

3 files changed

+28
-4
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,18 +75,23 @@ claude-commands install --active # Install 13 core commands
7575
# OR
7676
claude-commands install --all # Install all 58 commands
7777

78-
# 4. Configure Claude Code settings (Recommended)
78+
# 4. Configure OIDC for GitHub Actions to AWS (NEW!)
79+
claude-commands oidc --help # Show OIDC configuration options
80+
claude-commands oidc --dry-run # Preview OIDC setup actions
81+
claude-commands oidc --region us-west-2 --stack-name my-oidc # Configure AWS OIDC
82+
83+
# 5. Configure Claude Code settings (Recommended)
7984
claude-commands config --list # List available templates
8085
claude-commands config --template basic-settings.json # Apply basic config
8186
# OR
8287
claude-commands config --template security-focused-settings.json # Enhanced security
8388
# OR
8489
claude-commands config --template comprehensive-settings.json # Full features
8590

86-
# 5. Install AI subagents (Optional)
91+
# 6. Install AI subagents (Optional)
8792
claude-commands subagents --install # Install 26 specialized AI subagents
8893

89-
# 6. Start using AI-powered development commands
94+
# 7. Start using AI-powered development commands
9095
claude
9196
/xtest # Run all tests intelligently
9297
/xquality # Check and fix code quality issues

claude-dev-toolkit/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ claude-commands install --all # Install all 58 commands
4949
```bash
5050
claude-commands list # See all available commands
5151
claude-commands status # Check installation status
52+
claude-commands oidc --help # Configure GitHub Actions OIDC with AWS
5253
```
5354

5455
## 📋 Available Commands
@@ -97,6 +98,11 @@ claude-commands config --list # List available templates
9798
claude-commands config --template <name> # Apply configuration template
9899
claude-commands config --help # Show config command help
99100

101+
# OIDC Configuration (NEW)
102+
claude-commands oidc --help # Show OIDC configuration options
103+
claude-commands oidc --dry-run # Preview OIDC setup actions
104+
claude-commands oidc --region us-west-2 --stack-name my-oidc # Configure AWS OIDC
105+
100106
# Subagents Management
101107
claude-commands subagents --list # List available subagents
102108
claude-commands subagents --install # Install subagents to Claude Code
@@ -264,6 +270,13 @@ npm test
264270

265271
## 🔄 Recent Updates
266272

273+
### Version 0.0.1-alpha.9
274+
-**NEW: OIDC Command**: GitHub Actions to AWS OIDC integration (`claude-commands oidc`)
275+
-**TDD Implementation**: Phase 1 foundation with comprehensive test coverage (14/14 tests)
276+
-**CLI Integration**: Full command-line interface with help, dry-run, and configuration options
277+
-**Error Framework**: Enhanced error handling with context-aware recovery suggestions
278+
-**Dependency Validation**: AWS CLI, Git, and GitHub CLI availability checking
279+
267280
### Version 0.0.1-alpha.8
268281
-**Documentation Consistency**: Fixed command counts (58) and subagent counts (26)
269282
-**Test Infrastructure**: Enhanced test-results directory handling

docs/plans/oidc-tdd-implementation-plan.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,13 @@ This document outlines a Test-Driven Development (TDD) approach for implementing
3838
- Add validation through validation-utils.js
3939
- Support essential flags: --help, --dry-run, --verbose
4040

41-
**Phase 1 Rationale**: Without these foundations, you cannot test any OIDC functionality. Command structure enables testing, dependency validation prevents runtime failures, error handling provides debugging capability.
41+
5. **REQ-DOC-001**: Documentation Updates
42+
- Update claude-dev-toolkit/README.md with OIDC command usage
43+
- Update main README.md with OIDC command examples
44+
- Include CLI help examples and configuration options
45+
- Document version changes in release notes
46+
47+
**Phase 1 Rationale**: Without these foundations, you cannot test any OIDC functionality. Command structure enables testing, dependency validation prevents runtime failures, error handling provides debugging capability. Documentation ensures users understand the new functionality.
4248

4349
### Phase 2: Core Detection System
4450
**Goal**: Enable auto-detection of project context

0 commit comments

Comments
 (0)