Skip to content

Commit f7ba316

Browse files
committed
Updated model commands
1 parent 907eb6e commit f7ba316

File tree

35 files changed

+2377
-2593
lines changed

35 files changed

+2377
-2593
lines changed

.claude/agents/e2e-test-engineer.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,10 +144,10 @@ When updating tests due to functionality changes:
144144
3. **Additional detailed queries (when needed):**
145145
```bash
146146
# Get all verifications with full details
147-
./target/debug/reqvire model-summary --filter-type="verification" --json > /tmp/all-verifications.json
148-
147+
./target/debug/reqvire model summary --filter-type="verification" --json > /tmp/all-verifications.json
148+
149149
# Human-readable list of all verifications
150-
./target/debug/reqvire model-summary --filter-type="verification"
150+
./target/debug/reqvire model summary --filter-type="verification"
151151
```
152152

153153
**Decision Framework:**

.claude/agents/requirements-engineer.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -223,22 +223,31 @@ specifications/
223223
reqvire validate [--json]
224224

225225
# Generate model summary with filters
226-
reqvire model-summary [filters] [--json]
226+
reqvire model summary [filters] [--json]
227227

228228
# Generate sections summary (files/sections only, no elements)
229-
reqvire sections-summary [filters] [--json]
229+
reqvire model section-summary [filters] [--json]
230+
231+
# Generate index document
232+
reqvire model index
230233

231234
# Analyze change impact
232235
reqvire change-impact --git-commit=<commit> [--json]
233236

234237
# Generate traceability matrix
235-
reqvire traces [--json]
238+
reqvire verifications matrix [--json]
239+
240+
# Generate verification traces
241+
reqvire verifications traces [--json] [--filter-id=<id>] [--filter-name=<regex>] [--filter-type=<type>]
236242

237-
# Lint specifications
238-
reqvire lint [--dry-run]
243+
# Generate verification coverage report
244+
reqvire verifications coverage [--json]
245+
246+
# Format specifications
247+
reqvire format [--dry-run] [--json]
239248

240249
# Generate HTML documentation
241-
reqvire html
250+
reqvire html --output <dir>
242251

243252
# Generate diagrams
244253
reqvire generate-diagrams
@@ -261,23 +270,26 @@ reqvire generate-diagrams
261270
reqvire validate --json > /tmp/validation.json
262271

263272
# Filtered model summary
264-
reqvire model-summary --filter-type="requirement" --filter-is-not-verified --json
273+
reqvire model summary --filter-type="requirement" --filter-is-not-verified --json
265274

266275
# Sections overview (without individual elements)
267-
reqvire sections-summary --filter-file="specifications/*.md" --json
276+
reqvire model section-summary --filter-file="specifications/*.md" --json
268277

269278
# Change impact analysis
270279
reqvire change-impact --git-commit=HEAD~1 --json > /tmp/impact.json
280+
281+
# Generate index and save to file
282+
reqvire model index > index.md
271283
```
272284

273285
## Your Workflow
274286

275287
### 1. Discovery Phase:
276-
- Use `reqvire sections-summary --filter-content="security|authentication|authorization"` to understand security requirements in each section
277-
- Use `reqvire sections-summary --filter-content="performance|latency|throughput"` to identify performance-related requirements
278-
- Use `reqvire sections-summary --filter-content="validation|verify|test"` to find verification and testing requirements
279-
- Use `reqvire sections-summary --filter-content="interface|API|integration"` to locate interface requirements
280-
- Run `reqvire model-summary` to understand current state
288+
- Use `reqvire model section-summary --filter-content="security|authentication|authorization"` to understand security requirements in each section
289+
- Use `reqvire model section-summary --filter-content="performance|latency|throughput"` to identify performance-related requirements
290+
- Use `reqvire model section-summary --filter-content="validation|verify|test"` to find verification and testing requirements
291+
- Use `reqvire model section-summary --filter-content="interface|API|integration"` to locate interface requirements
292+
- Run `reqvire model summary` to understand current state
281293
- Use `reqvire validate --json > /tmp/validation.json` to identify issues
282294
- Apply filters to focus on specific areas
283295

@@ -303,7 +315,7 @@ reqvire change-impact --git-commit=HEAD~1 --json > /tmp/impact.json
303315
## Best Practices
304316

305317
### Strategic Content Analysis:
306-
- Use `sections-summary --filter-content` to understand requirement themes in each section before detailed work
318+
- Use `model section-summary --filter-content` to understand requirement themes in each section before detailed work
307319
- Filter by domain keywords (security, performance, interface) to map requirement distribution
308320
- Identify sections with specific requirement types to target your analysis effectively
309321

CLAUDE.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,23 @@ This guide is split into domain-specific guides for better organization:
2323
- Format: `cargo fmt`
2424

2525
### Basic Reqvire Commands
26-
- **Validate sructure**: `./target/debug/reqvire validate --json > /tmp/validation.json`
26+
- **Validate structure**: `./target/debug/reqvire validate --json > /tmp/validation.json`
2727
- **Format requirements (preview only)**: `./target/debug/reqvire format --dry-run`
28-
- **Apply formating fixes**: `./target/debug/reqvire format`
28+
- **Apply formatting fixes**: `./target/debug/reqvire format`
2929
- **Generate diagrams**: `./target/debug/reqvire generate-diagrams`
30-
- **Generate index document**: `./target/debug/reqvire generate-index`
31-
- **Generate model summary**: `./target/debug/reqvire model-summary`
32-
- **Generate model summary (JSON)**: `./target/debug/reqvire model-summary --json > /tmp/model-summary.json`
33-
- **Generate section summary**: `./target/debug/reqvire sections-summary`
34-
- **Generate section summary (JSON)**: `./target/debug/reqvire sections-summary --json > /tmp/model-summary.json`
30+
- **Generate index document**: `./target/debug/reqvire model index > SpecificationIndex.md`
31+
- **Generate model summary**: `./target/debug/reqvire model summary`
32+
- **Generate model summary (JSON)**: `./target/debug/reqvire model summary --json > /tmp/model-summary.json`
33+
- **Generate section summary**: `./target/debug/reqvire model section-summary`
34+
- **Generate section summary (JSON)**: `./target/debug/reqvire model section-summary --json > /tmp/section-summary.json`
3535
- **Generate HTML documentation**: `./target/debug/reqvire html --output <OUTPUT_DIR>`
3636
- **Analyze change impact**: `./target/debug/reqvire change-impact --git-commit=<COMMIT_HASH>`
3737
- **Analyze change impact (JSON)**: `./target/debug/reqvire change-impact --git-commit=HEAD~1 --json > /tmp/impact.json`
38-
- **Generate verification traces**: `./target/debug/reqvire verification-traces` - Generates upward traceability from verifications to root requirements with Mermaid diagrams
39-
- **Generate verification traces (JSON)**: `./target/debug/reqvire verification-traces --json > /tmp/verification-traces.json` - JSON output with trace trees for programmatic analysis
40-
- **Filter verification traces**: `./target/debug/reqvire verification-traces --filter-id=<id>` or `--filter-name=<regex>` or `--filter-type=<type>` - Filter to specific verifications
38+
- **Generate verification traces**: `./target/debug/reqvire verifications traces` - Generates upward traceability from verifications to root requirements with Mermaid diagrams
39+
- **Generate verification traces (JSON)**: `./target/debug/reqvire verifications traces --json > /tmp/verification-traces.json` - JSON output with trace trees for programmatic analysis
40+
- **Filter verification traces**: `./target/debug/reqvire verifications traces --filter-id=<id>` or `--filter-name=<regex>` or `--filter-type=<type>` - Filter to specific verifications
41+
- **Generate verification matrix**: `./target/debug/reqvire verifications matrix` - Generates verification traceability matrix
42+
- **Generate coverage report**: `./target/debug/reqvire verifications coverage` - Generates verification coverage report for leaf requirements
4143

4244

4345
### Filtering Options

0 commit comments

Comments
 (0)