Brooks Audit logo

Brooks Audit

CommunityPopular
hyhmrright
brooks-audit

Architecture audit that maps module dependencies, checks layering integrity, and flags structural decay across a codebase, drawing on twelve classic engineering books. Triggers when: user asks to audit architecture, review folder/module structure, check for circular imports, understand how the codebase is organized, or asks "does this follow clean architecture?" or "why does everything depend on everything?". Also triggers for onboarding requests: "explain this codebase to a new developer" or "give me a codebase tour" (use onboarding mode). Do NOT trigger for: PR-level code review (use brooks-review) or line-level refactoring questions — this skill analyzes structural/module-level concerns, not individual functions.

Overview

Publisherhyhmrright
Repositorybrooks-lint
Skill namebrooks-audit
Stars
1.5K
Forks
67
Bundled files
2
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • 2 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by hyhmrright on GitHub. Read the source before you install it.

Installation

Install the Brooks Audit AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/hyhmrright/brooks-lint.git /tmp/brooks-lint
mkdir -p .claude/skills
cp -r /tmp/brooks-lint/skills/brooks-audit .claude/skills/brooks-audit
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Brooks Audit in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Brooks Audit on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Brooks Audit is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Brooks-Lint — Architecture Audit

Setup

Read in order:

  1. ../_shared/common.md — Iron Law, Project Config, Report Template, Health Score
  2. ../_shared/source-coverage.md — book coverage, exceptions, tradeoffs
  3. ../_shared/decay-risks.md — symptom definitions and source attributions
  4. architecture-guide.md (this directory) — the audit framework

Process

Onboarding mode: If the user asks for an onboarding report, codebase tour, or "explain this codebase to a new developer", read onboarding-guide.md from this directory and follow it instead of architecture-guide.md. This mode explains rather than diagnoses — no Health Score, no Iron Law findings.

Scope: if the user did not specify files or a directory, apply Auto Scope Detection (../_shared/common.md) first.

  1. Gather codebase context and draw the module dependency graph as Mermaid (Steps 0–1 of the guide)
  2. Scan for each decay risk in the order specified (Steps 2–4 of the guide)
  3. Assign node colors in the Mermaid diagram based on findings (red/yellow/green) — after Step 4
  4. Run the Testability Seam Assessment (Step 5 of the guide)
  5. Run the Conway's Law check (Step 6 of the guide)
  6. Output using the Report Template from common.md — Mermaid graph FIRST, then Findings

Mode line in report: Architecture Audit

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Brooks Audit AI skill do?

Architecture audit that maps module dependencies, checks layering integrity, and flags structural decay across a codebase, drawing on twelve classic engineering books. Triggers when: user asks to audit architecture, review folder/module structure, check for circular imports, understand how the codebase is organized, or asks "does this follow clean architecture?" or "why does everything depend on everything?". Also triggers for onboarding requests: "explain this codebase to a new developer" or "give me a codebase tour" (use onboarding mode). Do NOT trigger for: PR-level code review (use broo...

Why use Brooks Audit on TypingMind?

Because you install it once and use it with any model. Brooks Audit is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Brooks Audit in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/hyhmrright/brooks-lint/tree/main/skills/brooks-audit. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Brooks Audit?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Brooks Audit?

As many as you like. As long as a model supports skills, you can use Brooks Audit with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Brooks Audit AI skill free?

Yes. It is published on GitHub by hyhmrright under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇