analyze-codebase

Files (5)

• SKILL.md
• analysis-dimensions.md · references/
• platform-orchestration.md · references/
• platform-paths.md · references/
• report.md · templates/

SKILL.md (first lines)

# Analyze Codebase

Perform structured analysis and persist findings as **`CODING_REQUIREMENTS.md`**
— prescriptive, imperative requirements future agents must follow.

Write rules as actionable imperatives with concrete examples from the codebase
(`Use Result<T, E> for fallible ops — see src/db/query.rs`), not observations.

## Step 1 — Resolve Scope

1. Path argument if provided
2. Attached or mentioned files/folders
3. Full project (default)

Announce: `Analysing scope: <path>`

## Step 2 — Load Checklist

Read `references/analysis-dimensions.md` and keep in context.

## Step 3 — Discover Layout

Glob 3 levels deep (exclude `node_modules`, `.git`, `target`, `build`, `dist`).
Read entry points, manifests, linters, test config, CI, and existing instructions
(`AGENTS.md`, `CLAUDE.md`, `.cursor/rules`, `CODING_REQUIREMENTS.md`).

## Step 4 — Deep-Dive (16 Dimensions)

For each dimension, read 3–5 representative files across modules. Capture:
- Imperative rule
- File:line example
- Anti-patterns to avoid

## Step 5 — Write Output

Use `templates/report.md`. Resolve output path per `references/platform-paths.md`
(prefer `docs/CODING_REQUIREMENTS.md`, then platform-specific dirs, then root).

## Step 6 — Wire Agent Instructions

Create platform-appropriate pointer files so conventions auto-load.
See `references/platform-paths.md` for Cursor, Claude, and Codex paths.

## Step 7 — Confirm

```
✓ Analysis complete.
Requirements: <path>
Pointer: <platform instructions file>
Re-run after significant architectural changes.
```

## Rules

- Prescriptive imperatives only; cite real code
- Read files, don't infer from names
- Never modify source files — only requirements and pointer files
- Pair with `write-conformant-code` skill for implementation

From dasobral/skills, MIT.

More from dasobral/skills