Project Context Sync
Skill by joe3112
Why use this skill?
Keep your AI agents informed with Project Context Sync. Automate documentation and commit summaries directly in your repo for seamless development workflows.
Install via CLI (Recommended)
clawhub install openclaw/skills/skills/joe3112/project-context-syncWhat This Skill Does
The Project Context Sync skill is a powerful developer-focused automation tool designed to bridge the gap between git history and AI agent awareness. By maintaining an auto-updated PROJECT_STATE.md file in the root of your repository, this skill transforms static git logs into a living, breathing document. After every commit, a post-commit hook triggers to aggregate branch status, recent commit history, and specific file changes. When configured with AI summarization, it leverages the OpenClaw gateway to parse these changes and generate intelligent insights into the project's current trajectory, effectively acting as an onboard navigation system for your AI agents. It eliminates the 'cold start' problem when switching between sessions or different AI agents by providing an immediate, high-level overview of what the codebase is currently doing.
Installation
To install, navigate to your local repository directory and execute the following in your terminal:
/path/to/skills/project-context-sync/scripts/install.sh
Alternatively, if you have the skill globally indexed, simply run project-context-sync install. This process will automatically generate the necessary .project-context.yml file, initialize the PROJECT_STATE.md file, and append the required post-commit git hooks. Ensure your ~/.clawdbot/clawdbot.json is configured with the gateway chat completions endpoint enabled if you wish to utilize the AI-driven smart summarization features.
Use Cases
- Seamless Agent Handoff: Pass the same repo to a different team member or AI agent; the
PROJECT_STATE.mdacts as an instant briefing document. - Automated Documentation: Eliminate the manual burden of writing status updates or progress reports during active development cycles.
- Contextual Awareness: Provide AI agents with a 'current focus' and 'suggested next' section that evolves with your commits, leading to better code suggestions and problem solving.
Example Prompts
- "OpenClaw, read the
PROJECT_STATE.mdin my current directory and tell me what the last three commits were focused on." - "Based on the current project state, suggest a refactoring plan that aligns with the 'current focus' section."
- "Summarize the changes made in the last 24 hours as documented in my project state file."
Tips & Limitations
- Token Usage: Enabling
ai_summaryconsumes tokens for every commit. For large repos, you may want to limit therecent_commitssetting to keep costs low. - Security: Ensure that the gateway HTTP API is restricted to loopback connections. While local risk is minimal, your configuration files hold API keys that should not be shared.
- Git Integration: This skill modifies your local
.git/hooksfolder. If you use other git hook managers, ensure they are compatible with post-commit hooks.
Metadata
Not sure this is the right skill?
Describe what you want to build — we'll match you to the best skill from 16,000+ options.
Find the right skillPaste this into your clawhub.json to enable this plugin.
{
"plugins": {
"official-joe3112-project-context-sync": {
"enabled": true,
"auto_update": true
}
}
}Tags(AI)
Flags: file-write, file-read, external-api