acquire-codebase-knowledge

Scan a repository and generate seven evidence-backed markdown documentation artifacts.

Updated Mar 11, 2026
One-click install
npx skills add https://github.com/selfagency/agentsy --skill acquire-codebase-knowledge-selfagency
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: acquire-codebase-knowledge
Source: https://github.com/selfagency/agentsy/tree/main/.agents/skills/acquire-codebase-knowledge
Command: npx skills add https://github.com/selfagency/agentsy --skill acquire-codebase-knowledge-selfagency

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires subprocess, argparse, json, os, sys, pathlib, re, typing, collections, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

It turns an unfamiliar or partially understood codebase into a set of actionable, verifiable documentation artifacts without guessing.

Core Features & Use Cases

  • Repo discovery scan: Runs a project-root scan to capture directory structure, manifests, entry points, CI/CD, containers, security config, performance markers, and code-metric summaries that can be referenced as evidence.
  • Intent-to-reality documentation: Produces seven documentation files that only state what is verifiable from files or terminal output, marking unknowns as [TODO] and team-intent gaps as [ASK USER].
  • Onboarding and maintainability packaging: Outputs a complete docs bundle covering stack, structure, architecture, conventions, integrations, testing, and concerns so engineers can ramp up quickly and safely.

Quick Start

Use the acquire-codebase-knowledge skill to scan the target repository and populate the required seven documents in docs/codebase/ from its verifiable evidence.

Frequently Asked Questions about acquire-codebase-knowledge

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

FAQPage Schema
How do I generate documentation for an unfamiliar codebase to speed up developer onboarding?

To generate codebase documentation for developer onboarding, you run a project-root scan mapping directory structure, manifests, and entry points into verifiable markdown artifacts. This creates evidence-backed docs without guessing, explicitly marking unknowns as [TODO] or [ASK USER].

What is evidence-backed repository documentation and how does it work?

Evidence-backed repository documentation means every statement in the generated docs is verifiable from files or terminal output. It works by running a scan script validating documentation against inquiry checkpoints, enforcing strict traceability to evidence and surfacing unresolved items.

Can I map monorepo architecture and discover integrations using automated codebase scanning?

Yes, you can map monorepo architecture and discover integrations through automated codebase scanning. The scan captures CI/CD, containers, security config, and performance markers, packaging them into a complete docs bundle covering stack, structure, and conventions.

How do I document codebase architecture with a focus on specific sections?

To document codebase architecture with a focus on specific sections, you request repository-level discovery with an optional focus area that prioritizes certain sections. The scan script populates the required seven documents from verifiable evidence based on that priority.

What are the limitations of automated codebase mapping for repository documentation?

Automated codebase mapping for repository documentation is limited to stating what is verifiable from files or terminal output. It cannot guess team intent or infer undocumented architecture, meaning unresolved items are explicitly surfaced as [TODO] or [ASK USER] rather than filled with assumptions.