@mod-computer/mod 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,147 @@
+# mod-cli
+
+Spec-driven development with traceability. Connect your specs, code, and tests so reviews show the full picture.
+
+## Quick Start
+
+```bash
+# Install
+npm install -g @mod-computer/cli
+
+# Initialize workspace (installs /mod skill for Claude Code)
+mod init
+mod auth login
+
+# Start working
+git checkout -b feat/user-auth
+```
+
+## The Idea
+
+You write specs. Agents implement them. But at review time, how do you know what requirement each function addresses? What's tested? What changed but isn't connected to anything?
+
+mod-cli builds a trace graph as you work:
+
+```
+Spec requirement → Implementation → Tests
+```
+
+At review, `mod trace report` shows what's connected. `mod trace diff` catches what isn't.
+
+## Usage
+
+### With Claude Code (Recommended)
+
+`mod init` installs the `/mod` skill automatically. Use it to implement specs:
+
+```bash
+# Write a spec
+claude "Write a spec for user authentication in specs/auth.md"
+
+# Implement from spec - agent handles traces
+claude "/mod implement specs/auth.md"
+
+# Add tests - agent traces them to implementations
+claude "/mod test specs/auth.md"
+
+# Review coverage
+mod trace report specs/auth.md
+```
+
+### Manual Workflow
+
+```bash
+# Add traces as you work
+mod trace add specs/auth.md:15 --type=requirement
+mod trace add src/auth/login.ts:42 --type=implementation --link=req-login--a1b2
+
+# Link existing traces
+mod trace link impl-login--a1b2 spec-login--c3d4
+
+# View connections
+mod trace report specs/auth.md
+mod trace coverage
+
+# Find gaps before merge
+mod trace diff          # Untraced files on branch
+mod trace unmet         # Requirements without implementations
+```
+
+## Commands
+
+### Setup
+
+```bash
+mod init                # Initialize workspace, install /mod skill
+mod auth login          # Authenticate
+mod auth logout         # Sign out
+mod auth status         # Show auth state
+```
+
+### Traces
+
+```bash
+# Add traces
+mod trace add <file>:<line> --type=<type> ["description"]
+mod trace add <file>:<line> --type=<type> --link=<trace-id>
+
+# Link traces
+mod trace link <source-id> <target-id>
+
+# View traces
+mod trace list                    # All traces
+mod trace list --type=requirement # Filter by type
+mod trace list --file=<path>      # Filter by file
+mod trace get <trace-id>          # Get trace details
+
+# Reports
+mod trace report <file>           # Per-document coverage
+mod trace coverage                # Workspace-wide stats
+
+# Find gaps
+mod trace diff                    # Untraced files on branch
+mod trace diff main..HEAD         # Explicit git range
+mod trace unmet                   # Requirements without implementations
+```
+
+### Comments
+
+```bash
+mod comment add <file>:<line> "text"
+mod comment list [file]
+```
+
+## Trace Types
+
+| Type | Use For |
+|------|---------|
+| `requirement` | Specs, user stories, acceptance criteria |
+| `specification` | Detailed technical specs |
+| `implementation` | Code that builds something |
+| `test` | Code that verifies something |
+| `design` | Design docs, architecture notes |
+| `decision` | ADRs, decision records |
+| `utility` | Helpers that don't need tracing |
+
+## CI Integration
+
+Commands exit non-zero when issues exist:
+
+```bash
+# Pre-merge validation
+mod trace diff && mod trace unmet && git push
+```
+
+| Command | Exit 0 | Exit 1 |
+|---------|--------|--------|
+| `mod trace diff` | All changed files traced | Untraced files exist |
+| `mod trace unmet` | All requirements implemented | Unmet requirements |
+
+## Development
+
+```bash
+pnpm install    # Install dependencies
+pnpm build      # Build CLI
+pnpm dev        # Watch mode
+pnpm test       # Run tests
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mod-computer/mod",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "license": "MIT",
   "description": "Mod CLI - Spec-driven development with traceability",
   "bin": {
@@ -10,10 +10,14 @@
   "engines": {
     "node": ">=16"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/modcomputer/mod-monorepo"
+  },
   "keywords": [
     "cli",
     "mod",
     "traceability",
     "spec-driven"
   ]
-}
+}