repo-onboarding

Inspects a repository and generates AGENTS.md, TASKS.md, .claude/project.json, and GOTCHAS.md contract files.

Updated Apr 18, 2026
One-click install
npx skills add https://github.com/exerias21/brainstorm-toolkit --skill repo-onboarding-exerias21
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: repo-onboarding
Source: https://github.com/exerias21/brainstorm-toolkit/tree/main/skills/repo-onboarding
Command: npx skills add https://github.com/exerias21/brainstorm-toolkit --skill repo-onboarding-exerias21

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Onboards a repository by generating the cross-tooling contract files (AGENTS.md, TASKS.md, .claude/project.json, GOTCHAS.md) needed by the toolkit, ensuring a ready-to-use baseline.

Core Features & Use Cases

  • Generates essential onboarding artifacts at repo root to align agents and tooling.
  • Produces a concise discovery report detailing detected repo characteristics.
  • Replaces separate onboarding steps; supports /onboard, /discovery, /codelearn, /init-toolkit flows.

Quick Start

Drop the brainstorm-toolkit skills into the repo and run the onboarding command to generate AGENTS.md, TASKS.md, GOTCHAS.md, and .claude/project.json.

Frequently Asked Questions about repo-onboarding

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

FAQPage Schema
How do I generate AGENTS.md and project.json files for repository onboarding?

To generate repository onboarding files like AGENTS.md and project.json, you inspect the repository to produce required contract files and a discovery report detailing detected repo characteristics.

What is the best way to bootstrap repo governance docs in one pass?

Bootstrapping repo governance docs in one pass involves inspecting the repository to automatically generate cross-tool contract files like AGENTS.md, TASKS.md, GOTCHAS.md, and .claude/project.json at the repo root.

Do I need any dependencies to create a discovery report for my codebase?

No dependencies are required to create a discovery report for your codebase; you drop the toolkit skills into the repo and run the onboarding command to generate artifacts and detect repo characteristics.

How does generating GOTCHAS.md help align agents and tooling?

Generating GOTCHAS.md aligns agents and tooling by producing essential onboarding artifacts at the repo root, establishing a ready-to-use baseline contract that replaces separate onboarding steps.

Can I use this onboarding process for the /discovery or /codelearn commands?

Yes, you can use this onboarding process for the /discovery, /codelearn, /init-toolkit, and /onboard commands, as it generates the required contract files these workflows rely on.

When do I need to generate cross-tool contract files for a new repository?

You need to generate cross-tool contract files when onboarding a new repository to the workflow toolkit, ensuring agents and tooling have a ready-to-use baseline of governance docs.