Skip to content

Commit f242b58

Browse files
authored
docs(readme): fix CLI command examples to include 'assess' subcommand (#126)
The README documentation showed incorrect command usage like 'agentready .' when the actual CLI implementation requires 'agentready assess .'. This fix updates all command examples in the README to match the current CLI structure. Changes: - Updated 'Assessment Only' section examples - Updated 'CLI Reference' section - Updated 'Quick Start' footer command Fixes the discrepancy between documented and actual CLI usage.
1 parent e4850d3 commit f242b58

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -63,16 +63,16 @@ For one-time analysis without infrastructure changes:
6363

6464
```bash
6565
# Assess current repository
66-
agentready .
66+
agentready assess .
6767

6868
# Assess another repository
69-
agentready /path/to/your/repo
69+
agentready assess /path/to/your/repo
7070

7171
# Specify custom configuration
72-
agentready /path/to/repo --config my-config.yaml
72+
agentready assess /path/to/repo --config my-config.yaml
7373

7474
# Custom output directory
75-
agentready /path/to/repo --output-dir ./reports
75+
agentready assess /path/to/repo --output-dir ./reports
7676
```
7777

7878
### Example Output
@@ -156,10 +156,10 @@ output_dir: ./custom-reports
156156
157157
```bash
158158
# Assessment commands
159-
agentready PATH # Assess repository at PATH
160-
agentready PATH --verbose # Show detailed progress
161-
agentready PATH --config FILE # Use custom configuration
162-
agentready PATH --output-dir DIR # Custom report location
159+
agentready assess PATH # Assess repository at PATH
160+
agentready assess PATH --verbose # Show detailed progress
161+
agentready assess PATH --config FILE # Use custom configuration
162+
agentready assess PATH --output-dir DIR # Custom report location
163163

164164
# Configuration commands
165165
agentready --validate-config FILE # Validate configuration
@@ -273,4 +273,4 @@ Contributions welcome! Please ensure:
273273

274274
---
275275

276-
**Quick Start**: `pip install -e ".[dev]" && agentready .` - Ready in <5 minutes!
276+
**Quick Start**: `pip install -e ".[dev]" && agentready assess .` - Ready in <5 minutes!

0 commit comments

Comments
 (0)