sync-agents

Generate or update AGENTS.md from repository manifests and key files.

1|Updated Apr 17, 2026

Search Tags:#documentation #onboarding #codebase #ai #agents #sync

Ready to run

npx skills add https://github.com/justincordova/agents --skill sync-agents-justincordova

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: sync-agents
Source: https://github.com/justincordova/agents/tree/main/skills/sync-agents
Command: npx skills add https://github.com/justincordova/agents --skill sync-agents-justincordova

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates or updates AGENTS.md — a structured onboarding file that gives AI agents enough context to work effectively in a codebase without reading every file. Think of it as a "README for agents."

Core Features & Use Cases

Automated onboarding: Produce a consistent AGENTS.md that summarizes project identity, layout, and critical entry points so agents can start quickly.
Repo discovery: Scan common manifests (package.json, go.mod, Cargo.toml, pyproject.toml, etc.) and key files to populate context.
Maintenance & updates: Reconcile changes over time by refreshing the onboarding document when the project evolves.

Quick Start

Create or update AGENTS.md in the project root to initialize the agent onboarding document.

Frequently Asked Questions about sync-agents

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

FAQPage Schema

How do I generate onboarding documentation for AI agents working in my codebase?▼

Generate onboarding documentation for AI agents by creating an AGENTS.md file that provides structured context about your codebase. The skill scans repository manifests and key files to output a ready-to-use summary of repo identity, layout, and critical entry points.

What is an AGENTS.md file and why do I need one for my repository?▼

An AGENTS.md file is a structured onboarding document that gives AI agents concise codebase context without reading every file. You need one to help agents quickly understand repo identity, layout, and critical entry points for effective automated work.

Can I use this to generate agent context for projects with package.json or go.mod manifests?▼

Yes, you can generate agent context for projects with package.json, go.mod, or similar manifests. The skill analyzes these repository manifests alongside key files to populate the AGENTS.md onboarding document with accurate project layout and entry point details.

How do I update AI agent context when my project structure evolves?▼

Update AI agent context by running the skill to reconcile changes and refresh your AGENTS.md file. It scans modified repository manifests and key files to maintain an accurate onboarding document that reflects your project's evolving structure and critical entry points.

What's the best way to give an AI coding agent context about a large codebase?▼

The best way to give an AI coding agent context is to generate a structured AGENTS.md file summarizing repo identity, layout, and entry points. This prevents agents from reading every file while providing enough context to start working effectively in the codebase.

Do I need to manually review the generated AGENTS.md before using it with agents?▼

Yes, you should manually review the generated AGENTS.md before using it with agents. The skill outputs a ready-to-use onboarding document that humans can review and update to ensure the codebase context remains accurate and relevant for ongoing work.