codebase-report

Name: codebase-report
Availability: InStock
Author: Nightstream

Generate architecture reports with file:line references from scanned codebases.

29|8|Updated Aug 17, 2025

Search Tags:#onboarding #codebase analysis #test infrastructure #architecture documentation #technical report #dependency inventory #data flow mapping

Ready to run

npx skills add https://github.com/LFDT-Nightstream/Nightstream --skill codebase-report-lfdt-nightstream

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: codebase-report
Source: https://github.com/LFDT-Nightstream/Nightstream/tree/main/.agents/skills/codebase-report
Command: npx skills add https://github.com/LFDT-Nightstream/Nightstream --skill codebase-report-lfdt-nightstream

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

It turns short-lived code exploration into durable, referenceable technical architecture documentation, so teams can onboard faster and preserve understanding after context compaction.

Core Features & Use Cases

Comprehensive architecture reporting: Generates a full report covering executive summary, entry points, key types, data flow, dependencies, configuration, and test infrastructure.
File-backed accuracy: Promotes including file and line references to make the documentation trustworthy and easy to audit.
Reusable scaffolding workflow: Uses a scaffold script plus optional templates/examples to quickly produce a draft that you can refine for onboarding, PR context, handoffs, or audits.

Quick Start

Ask the agent to run codebase-report on a repository at /path/to/project and produce ARCHITECTURE.md using the scaffold script, then fill remaining sections using references/TEMPLATE.md.

Frequently Asked Questions about codebase-report

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

FAQPage Schema

How do I generate architecture documentation from an unknown codebase?▼

Generate architecture documentation by running a scaffold script to produce a structured markdown artifact, then fill sections for entry points, data flow, and dependencies using file:line references for auditability.

What is the best way to document codebase exploration for onboarding?▼

Document codebase exploration for onboarding by converting short-lived findings into a durable technical report that summarizes core types, configuration precedence, and test infrastructure for new team members.

Can I automate technical report generation for repository handoffs?▼

Yes, you can automate technical report generation for repository handoffs by applying a reusable scaffolding workflow that extracts end-to-end data flow and dependency inventory into a referenceable markdown format.

Does codebase analysis work without external dependencies?▼

Codebase analysis operates without external dependencies, using internal scripts and reference templates to map data flow and inventory dependencies directly from the repository structure.

When do I need a scaffold script for architecture documentation?▼

You need a scaffold script for architecture documentation when you require a repeatable structure to consistently summarize entry points, core types, and test infrastructure across multiple unknown or partially understood repositories.

Why include file and line references in a technical architecture report?▼

Include file and line references in a technical architecture report to make the documentation trustworthy and easy to audit, ensuring that summarized entry points and data flows trace directly to the source code.