Skip to content

AGENTS.md

Latest commit

 

History

History
74 lines (59 loc) · 3.26 KB

AGENTS.md

File metadata and controls

74 lines (59 loc) · 3.26 KB

AGENTS.md — Rivet Project Instructions

This file was generated by rivet init --agents. Re-run the command any time artifacts change to keep this file current.

Project Overview

This project uses Rivet for SDLC artifact traceability.

  • Config: rivet.yaml
  • Schemas: common, dev
  • Artifacts: 2 across 2 types
  • Validation: rivet validate (current status: pass)

Available Commands

Command Purpose Example
rivet validate Check link integrity, coverage, required fields rivet validate --format json
rivet list List artifacts with filters rivet list --type requirement --format json
rivet stats Show artifact counts by type rivet stats --format json
rivet add Create a new artifact rivet add -t requirement --title "..." --link "satisfies:SC-1"
rivet link Add a link between artifacts rivet link SOURCE -t satisfies --target TARGET
rivet serve Start the dashboard rivet serve --port 3000
rivet export Generate HTML reports rivet export --format html --output ./dist
rivet impact Show change impact rivet impact --since HEAD~1
rivet coverage Show traceability coverage rivet coverage --format json
rivet diff Compare artifact versions rivet diff --base path/old --head path/new

Artifact Types

Type Count Description
feature 1 A user-visible capability or feature
requirement 1 A functional or non-functional requirement
design-decision 0 An architectural or design decision with rationale

Working with Artifacts

File Structure

  • Artifacts are stored as YAML files in: artifacts
  • Schema definitions: schemas/ directory
  • Documents: (none configured)

Creating Artifacts

rivet add -t requirement --title "New requirement" --status draft --link "satisfies:SC-1"

Validating Changes

Always run rivet validate after modifying artifact YAML files. Use rivet validate --format json for machine-readable output.

Link Types

Link Type Description Inverse
allocated-to Source is allocated to the target (e.g. requirement to architecture component) allocated-from
constrained-by Source is constrained by the target constrains
depends-on Source depends on target being completed first depended-on-by
derives-from Source is derived from the target derived-into
implements Source implements the target implemented-by
mitigates Source mitigates or prevents the target mitigated-by
refines Source is a refinement or decomposition of the target refined-by
satisfies Source satisfies or fulfils the target satisfied-by
traces-to General traceability link between any two artifacts traced-from
verifies Source verifies or validates the target verified-by

Conventions

  • Artifact IDs follow the pattern: PREFIX-NNN (e.g., REQ-001, FEAT-042)
  • Use rivet add to create artifacts (auto-generates next ID)
  • Always include traceability links when creating artifacts
  • Run rivet validate before committing