research-codebase

Sweep a repository with Codex and synthesize findings into tasks/research-codebase.md.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/KMakayee/playbook --skill research-codebase-kmakayee
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: research-codebase
Source: https://github.com/KMakayee/playbook/tree/main/.claude/skills/research-codebase
Command: npx skills add https://github.com/KMakayee/playbook --skill research-codebase-kmakayee

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents wasted engineering cycles by researching the current repository before designing or implementing a change, producing a structured understanding of what exists, where, and how it connects.

Core Features & Use Cases

  • Research orchestration (Codex + Claude): runs a two-stage workflow where Codex sweeps the codebase and Claude synthesizes into actionable research artifacts.
  • Guardrails before starting: blocks execution if prior research/design/plan artifacts already exist, and enforces readiness checks for unresolved gates and missing upfront spec fields.
  • Artifact production for downstream phases: writes a full research report to tasks/research-codebase.md, including design axes and external research requirements.
  • Use Case: When you need to add a feature or fix a bug in an unfamiliar codebase, this Skill maps relevant files, surfaces constraints, and produces axes for the next design step.

Quick Start

Use the research-codebase skill by running: /research-codebase add retry logic to the ingest worker.

Frequently Asked Questions about research-codebase

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

FAQPage Schema
How do I research an unfamiliar codebase before implementing a new feature?

Codebase research before implementation involves sweeping the repository to map relevant files, surface constraints, and produce structured design axes for planning. This Skill orchestrates that sweep using Codex and synthesizes findings into an actionable research artifact.

What is the best way to map repository constraints for a downstream design task?

Mapping repository constraints for design requires analyzing existing code paths and connections to understand what exists and where. This Skill runs a two-stage workflow to sweep the codebase and synthesize evidence-backed findings into a structured markdown report.

How do I generate design axes for an engineering workflow in an unfamiliar repository?

Generating design axes requires synthesizing codebase context, relevant paths, and external research links into a structured format. This Skill validates repository findings and produces evidence-backed axes to guide the next design and planning phases.

Does this codebase research workflow require any existing task artifacts before starting?

Codebase research workflows typically require upfront spec fields and preflight checks for unresolved gates. This Skill blocks execution if prior research, design, or plan artifacts already exist, enforcing readiness checks before sweeping the repository.

Can I use Codex to sweep a repository and Claude to synthesize findings?

Using Codex to sweep a repository and Claude to synthesize findings is a supported two-stage workflow. This Skill orchestrates Codex execution with a repository-aware prompt, then validates the output and synthesizes it into actionable tasks.

When should I not use an automated codebase research approach?

Automated codebase research should not be used when prior research, design, or plan artifacts already exist for the task. This Skill enforces guardrails that block execution to prevent overwriting existing structured understanding or wasting engineering cycles.