gh-context

Generate or update AGENTS.md files documenting project architecture and conventions.

2|Updated Feb 17, 2017
One-click install
npx skills add https://github.com/John2143/dotfiles --skill gh-context
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gh-context
Source: https://github.com/John2143/dotfiles/tree/main/.claude/skills/gh-context
Command: npx skills add https://github.com/John2143/dotfiles --skill gh-context

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automates the generation or update of an AGENTS.md file, which documents project architecture, conventions, testing workflow, and patterns for autonomous coding agents, saving time and ensuring consistency.

Core Features & Use Cases

  • Automatic Generation: Create a new AGENTS.md file by discovering build files, source directories, and conventions.
  • Update Existing: Read the existing AGENTS.md and update only stale sections like changed commands, renamed directories, and new gotchas.
  • Use Case: For a software project, use this Skill to ensure that all autonomous coding agents have up-to-date information about the project's architecture and practices.

Quick Start

Run the gh-context skill to generate a fresh AGENTS.md for your project.

Frequently Asked Questions about gh-context

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate an AGENTS.md file for autonomous coding agents?

You can generate an AGENTS.md file by running the gh-context skill, which automatically discovers your project's architecture, conventions, and patterns to document context for autonomous coding agents.

Can I update existing project documentation for coding agents without rewriting everything?

Yes, you can update existing AGENTS.md files by reading the current content and refreshing only stale sections like changed commands, renamed directories, and new gotchas without rewriting the entire file.

What project context does automated AGENTS.md generation discover?

Automated AGENTS.md generation discovers build files, source directories, and project conventions to document architecture, testing workflows, and patterns for autonomous coding agents.

Do I need specific project files to generate documentation for autonomous agents?

Yes, you need to provide access to your project files and configuration for accurate context extraction, as the generation process relies on discovering your actual software architecture and conventions.

What is the best way to maintain consistent project documentation for autonomous agents?

The best way to maintain consistent documentation is to automate AGENTS.md generation, which discovers and documents your software architecture, conventions, and patterns to ensure all autonomous coding agents have up-to-date information.

Why should I use automated generation instead of manually writing AGENTS.md files?

You should use automated generation because it saves time and ensures consistency by automatically discovering build files, source directories, and conventions, reducing the risk of outdated or incomplete project documentation for coding agents.