Skip to content

Commit 6b95724

Browse files
committed
model commands amd verification subcommands unnested.
HTML export doesn't mutate model files, it uses tmp folder. HTML export has artifacts: traces, index, matrix included as header links.
1 parent e1d5e2a commit 6b95724

File tree

60 files changed

+4725
-2167
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+4725
-2167
lines changed

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

Lines changed: 2 additions & 2 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
147+
./target/debug/reqvire summary --filter-type="verification" --json > /tmp/all-verifications.json
148148

149149
# Human-readable list of all verifications
150-
./target/debug/reqvire model summary --filter-type="verification"
150+
./target/debug/reqvire summary --filter-type="verification"
151151
```
152152

153153
**Decision Framework:**

.claude/agents/requirements-engineer.md

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -222,26 +222,23 @@ specifications/
222222
# Validate specifications
223223
reqvire validate [--json]
224224

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

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

234231
# Analyze change impact
235232
reqvire change-impact --git-commit=<commit> [--json]
236233

237234
# Generate traceability matrix
238-
reqvire verifications matrix [--json]
235+
reqvire matrix [--json]
239236

240237
# Generate verification traces
241-
reqvire verifications traces [--json] [--filter-id=<id>] [--filter-name=<regex>] [--filter-type=<type>]
238+
reqvire traces [--json] [--filter-id=<id>] [--filter-name=<regex>] [--filter-type=<type>]
242239

243240
# Generate verification coverage report
244-
reqvire verifications coverage [--json]
241+
reqvire coverage [--json]
245242

246243
# Format specifications
247244
reqvire format [--dry-run] [--json]
@@ -269,27 +266,24 @@ reqvire generate-diagrams
269266
# Full validation with JSON output
270267
reqvire validate --json > /tmp/validation.json
271268

272-
# Filtered model summary
273-
reqvire model summary --filter-type="requirement" --filter-is-not-verified --json
269+
# Filtered summary
270+
reqvire summary --filter-type="requirement" --filter-is-not-verified --json
274271

275272
# Sections overview (without individual elements)
276-
reqvire model section-summary --filter-file="specifications/*.md" --json
273+
reqvire section-summary --filter-file="specifications/*.md" --json
277274

278275
# Change impact analysis
279276
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
283277
```
284278

285279
## Your Workflow
286280

287281
### 1. Discovery Phase:
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
282+
- Use `reqvire section-summary --filter-content="security|authentication|authorization"` to understand security requirements in each section
283+
- Use `reqvire section-summary --filter-content="performance|latency|throughput"` to identify performance-related requirements
284+
- Use `reqvire section-summary --filter-content="validation|verify|test"` to find verification and testing requirements
285+
- Use `reqvire section-summary --filter-content="interface|API|integration"` to locate interface requirements
286+
- Run `reqvire summary` to understand current state
293287
- Use `reqvire validate --json > /tmp/validation.json` to identify issues
294288
- Apply filters to focus on specific areas
295289

@@ -315,7 +309,7 @@ reqvire model index > index.md
315309
## Best Practices
316310

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

.github/workflows/change_impact.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
github.event.issue.pull_request != null &&
1111
(
1212
contains(github.event.comment.body, '/reqvire impact') ||
13-
contains(github.event.comment.body, '/reqvire verifications traces')
13+
contains(github.event.comment.body, '/reqvire traces')
1414
)
1515
runs-on: ubuntu-latest
1616

@@ -89,11 +89,11 @@ jobs:
8989
echo "$OUTPUT" >> $GITHUB_ENV
9090
echo "EOF" >> $GITHUB_ENV
9191
92-
- name: Run Reqvire Verifications Traces (if triggered)
93-
if: contains(github.event.comment.body, '/reqvire verifications traces')
92+
- name: Run Reqvire Traces (if triggered)
93+
if: contains(github.event.comment.body, '/reqvire traces')
9494
id: run_traces
9595
run: |
96-
OUTPUT=$(./reqvire verifications traces 2>&1 || echo "⚠️ reqvire verifications traces failed.")
96+
OUTPUT=$(./reqvire traces 2>&1 || echo "⚠️ reqvire traces failed.")
9797
echo "REQVIRE_OUTPUT<<EOF" >> $GITHUB_ENV
9898
echo "$OUTPUT" >> $GITHUB_ENV
9999
echo "EOF" >> $GITHUB_ENV

.github/workflows/generate_diagrams.yml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,7 @@ jobs:
4141
- name: Generate Diagrams
4242
run: |
4343
./reqvire generate-diagrams
44-
45-
- name: Generate traces svg
46-
run: |
47-
./reqvire verifications traces --svg > specifications/matrix.svg
48-
44+
4945
- name: Check for Changes
5046
id: check_changes
5147
run: |

CLAUDE.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,18 @@ This guide is split into domain-specific guides for better organization:
2727
- **Format requirements (preview only)**: `./target/debug/reqvire format --dry-run`
2828
- **Apply formatting fixes**: `./target/debug/reqvire format`
2929
- **Generate diagrams**: `./target/debug/reqvire generate-diagrams`
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`
35-
- **Generate HTML documentation**: `./target/debug/reqvire html --output <OUTPUT_DIR>`
30+
- **Generate model summary**: `./target/debug/reqvire summary`
31+
- **Generate model summary (JSON)**: `./target/debug/reqvire summary --json > /tmp/model-summary.json`
32+
- **Generate section summary**: `./target/debug/reqvire section-summary`
33+
- **Generate section summary (JSON)**: `./target/debug/reqvire section-summary --json > /tmp/section-summary.json`
34+
- **Generate HTML documentation**: `./target/debug/reqvire html --output <OUTPUT_DIR>` - Generates HTML output with index, diagrams, traces, coverage, and matrix
3635
- **Analyze change impact**: `./target/debug/reqvire change-impact --git-commit=<COMMIT_HASH>`
3736
- **Analyze change impact (JSON)**: `./target/debug/reqvire change-impact --git-commit=HEAD~1 --json > /tmp/impact.json`
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
37+
- **Generate verification traces**: `./target/debug/reqvire traces` - Generates upward traceability from verifications to root requirements with Mermaid diagrams
38+
- **Generate verification traces (JSON)**: `./target/debug/reqvire traces --json > /tmp/verification-traces.json` - JSON output with trace trees for programmatic analysis
39+
- **Filter verification traces**: `./target/debug/reqvire traces --filter-id=<id>` or `--filter-name=<regex>` or `--filter-type=<type>` - Filter to specific verifications
40+
- **Generate verification matrix**: `./target/debug/reqvire matrix` - Generates verification traceability matrix
41+
- **Generate coverage report**: `./target/debug/reqvire coverage` - Generates verification coverage report for leaf requirements
4342

4443

4544
### Filtering Options

0 commit comments

Comments
 (0)