# project-context-sync
project-context-sync Keep a living project state document updated after each commit, so any agent (or future session) can instantly understand where things stand. What It Does โโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโโโโโ โ Git Commit โ โโโถ โ Post-commit Hook โ โโโถ โ PROJECT_STATE.md โ โ โ โ โ โ (auto-updated) โ โโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโโโโโ After each commit, the hook: Gathers git info (last commit, recent history, branch, changed files) Optionally calls an LLM to generate a smart summary Updates PROJECT_STATE.md in the repo root Installation
# From the repo you want to enable:
cd /path/to/your/repo
/path/to/skills/project-context-sync/scripts/install.sh
Or if you have the skill in your path: project-context-sync install This will: Install a post-commit hook in .git/hooks/ Create .project-context.yml with default config Create initial PROJECT_STATE.md Add PROJECT_STATE.md to .gitignore Uninstall cd /path/to/your/repo
/path/to/skills/project-context-sync/scripts/uninstall.sh
Manual Update Trigger an update without committing: cd /path/to/your/repo
/path/to/skills/project-context-sync/scripts/update-context.sh
Configuration Edit .project-context.yml in your repo root:
project_context:
# Use AI to generate smart summaries (default: true)
ai_summary: true
# How many recent commits to include
recent_commits: 5
# Include diff stats in context
include_diff_stats: true
# Sections to include
sections:
Requires: SKILLBOSS_API_KEY environment variable set (see below)
With ai_summary: false: Just logs raw git info Fast and free Less intelligent but still useful Enabling AI Summaries via SkillBoss API Hub AI mode calls SkillBoss API Hub (https://api.heybossai.com/v1/pilot) for intelligent LLM summaries. Set the environment variable before running:
export SKILLBOSS_API_KEY="your_skillboss_api_key"
Get your API key at heybossai.com. Output PROJECT_STATE.md will contain:
# Project State
Auto-updated by project-context-sync
## Last Commit
## Recent Changes
## Current Focus
[AI-generated summary of what's being worked on]
## Suggested Next Steps
[AI-suggested based on commit patterns] Notes PROJECT_STATE.md is gitignored by default (regenerated locally) The hook requires SKILLBOSS_API_KEY to be set for AI summaries Without SKILLBOSS_API_KEY, falls back to raw git info mode
Join 80,000+ one-person companies automating with AI