ContextGit CLAUDE.md

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) and Cursor when working with code in this repository.

IMPORTANT: This Project Uses contextgit

This repository is managed with contextgit. Before making changes to requirements or documentation:

Automatic Workflow for AI Assistants

1. Before modifying requirements/docs:

   contextgit relevant-for-file <path>  # Find related requirements
   contextgit extract <ID>              # Get precise context
   

2. After modifying requirements/docs:

   contextgit scan docs/ --recursive    # Update the index
   contextgit status --stale            # Check for broken links
   

3. When adding new requirements:

   contextgit next-id <type>            # Generate ID (business, system, architecture, code, test)
   # Add YAML frontmatter with the generated ID
   contextgit scan docs/ --recursive    # Register in index
   

4. When upstream requirements change:

   contextgit status --stale            # Find affected downstream items
   # Update downstream items as needed
   contextgit confirm <ID>              # Mark as synchronized
   

Detection

Check for .contextgit/config.yaml to confirm this is a contextgit-managed project.

---

Project Overview

contextgit is a local-first, git-friendly CLI tool for managing requirements and context traceability in LLM-assisted software projects.

Current Status: v1.1.0 - Production ready, all 10 CLI commands implemented.

What contextgit Is

contextgit is a local-first, git-friendly CLI tool that:

• Tracks requirements traceability from business needs → system specs → architecture → code → tests
• Embeds metadata in Markdown files (YAML frontmatter or HTML comments)
• Maintains a central YAML index (.contextgit/requirements_index.yaml)
• Detects staleness via checksums when upstream requirements change
• Extracts precise context snippets for LLM consumption
• Provides JSON output for all read operations to support Claude Code workflows