kicchann-reqord

Reqord

日本語

Structured context for the AI era, version-controlled alongside your code.

Reqord stores requirements as structured data (YAML + Markdown) inside your Git repository, giving every requirement a clear lifecycle from draft to implementation. No SaaS, no backend -- just git clone and your entire requirements history is there, version-controlled alongside your code, ready for humans and AI tools alike.

Why Reqord?

Software teams lose track of requirements. The consequences compound over time:

• Scattered requirements -- decisions live in chat threads, meeting notes, and memory. Nothing is canonical.
• Lost context -- new team members and AI tools start every session without project background.
• Spec drift -- specifications written at project start are never updated. Implementation quietly diverges.
• Broken traceability -- no one can answer "why does this feature exist?" or "what breaks if we change it?"
• AI gets bad inputs -- unstructured text produces inconsistent AI output. Every session starts from scratch.

Reqord solves these by making requirements structured, versioned, and traceable -- stored right where your code lives.

How It Works

Reqord enforces a 3-layer traceability model that connects intent to implementation:

Requirement (What)  -->  Specification (How)  -->  GitHub Issue (Tasks)
       ^                                                  |
       '------------------ Feedback Loop -----------------'

Each layer links to the others. When a requirement changes, you can trace the impact through specifications to issues. When implementation feedback surfaces, it flows back to update requirements.

Lifecycle:

draft --> pending_approval --> approved --> implemented --> deprecated

Requirements move through a defined lifecycle with PR-based approval gates, so nothing gets lost and nothing ships without review.

Quick Start

Install

npm install -g @reqord/cli

# Optional: install the web dashboard
npm install -g @reqord/web

Claude Code Plugin

Reqord provides a Claude Code plugin for AI-assisted requirements workflow (design, TDD implementation, review, Git operations).

# Add the marketplace
/plugin marketplace add kicchann/reqord

# Install the plugin
/plugin install reqord@reqord-plugins

Initialize a project

cd /path/to/your/project

# Initialize the .reqord/ directory structure
reqord init

# Set up project context
reqord context init

Create your first requirement

# Create a requirement (supports user-story, ears, and free-form formats)
reqord req create

# List all requirements
reqord req list

# Validate requirement quality with SMART scoring
reqord req validate req-000001

See the Getting Started guide for the full walkthrough.

git clone https://github.com/kicchann/reqord.git
cd reqord
pnpm install
pnpm build
cd packages/cli && pnpm link --global

Key Features

Hybrid Storage (YAML + Markdown)

Requirements are stored as YAML metadata (status, priority, dependencies, version history) paired with Markdown content (descriptions, success criteria, use cases). Machine-readable structure with human-readable documentation.

SMART Validation

Built-in quality scoring based on the SMART framework (Specific, Measurable, Achievable, Relevant, Time-bound). Run reqord req validate to get an objective quality score and actionable improvement suggestions for any requirement.

PR-Based Approval Workflow