Skillshare Codebase Audit logo

Skillshare Codebase Audit

Organization
JetBrains
skillshare-codebase-audit

Cross-validate CLI flags, docs, tests, and targets for consistency across the codebase. Use this skill whenever the user asks to: audit the codebase, check for consistency issues, find undocumented flags, verify test coverage, validate targets.yaml, check handler split conventions, or verify oplog instrumentation. This is a read-only audit — it reports issues but never modifies files. Use after large refactors, before releases, or whenever you suspect docs/code/tests have drifted out of sync.

Overview

PublisherJetBrains
Repositoryskills
Skill nameskillshare-codebase-audit
Stars
377
Forks
32
Bundled files
Instructions only
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.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

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

Installation

Install the Skillshare Codebase 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.
    https://github.com/JetBrains/skills/tree/main/codebase-audit
  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/JetBrains/skills.git /tmp/skills
mkdir -p .claude/skills
cp -r /tmp/skills/codebase-audit .claude/skills/skillshare-codebase-audit
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Skillshare Codebase 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 Skillshare Codebase 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 Skillshare Codebase 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.

Read-only consistency audit across the skillshare codebase. $ARGUMENTS specifies focus area (e.g., "flags", "tests", "targets") or omit for full audit.

Scope: This skill only READS and REPORTS. It does not modify any files. Use implement-feature to fix issues or update-docs to fix documentation gaps.

Audit Dimensions

Run all 4 dimensions in parallel where possible. For each, produce a summary table.

1. CLI Flag Audit

Compare every flag defined in cmd/skillshare/*.go against website/docs/commands/*.md.

bash
# Find all flags in Go source
grep -rn 'flag\.\(String\|Bool\|Int\)' cmd/skillshare/
grep -rn 'Args\|Usage' cmd/skillshare/

Report:

  • UNDOCUMENTED: Flag exists in code but not in docs
  • STALE: Flag documented but not found in code
  • OK: Flag matches between code and docs

2. Spec vs Code

For each spec in specs/ marked as completed/done:

  • Verify the described feature exists in source code
  • Check that the spec's acceptance criteria are testable

Report:

  • IMPLEMENTED: Spec complete, code exists
  • MISMATCH: Spec says done but code missing or partial
  • PENDING: Spec not yet marked complete (informational)

3. Test Coverage

For each command handler in cmd/skillshare/<cmd>.go:

  • Check if tests/integration/<cmd>_test.go exists
  • Check if key behaviors have test cases
bash
# List all command handlers
ls cmd/skillshare/*.go | grep -v '_test.go\|main.go\|helpers.go\|mode.go'

# List all integration tests
ls tests/integration/*_test.go

Report:

  • COVERED: Command has integration test file with test cases
  • PARTIAL: Test file exists but missing key scenarios
  • MISSING: No integration test for this command

4. Target Audit

Verify internal/config/targets.yaml entries:

  • Each target has both global_path and project_path
  • Aliases are consistent
  • No duplicate entries

Report:

  • OK: Target entry complete and valid
  • INCOMPLETE: Missing required fields
  • DUPLICATE: Name or alias collision

Output Format

== Skillshare Codebase Audit ==

### CLI Flags (N issues)
| Command   | Flag        | Status       |
|-----------|-------------|--------------|
| install   | --force     | OK           |
| install   | --into      | UNDOCUMENTED |

### Specs (N issues)
| Spec File            | Status      |
|----------------------|-------------|
| copy-sync-mode.md    | IMPLEMENTED |
| some-feature.md      | MISMATCH    |

### Test Coverage (N issues)
| Command   | Status  | Notes              |
|-----------|---------|--------------------|
| sync      | COVERED |                    |
| audit     | PARTIAL | missing edge cases |
| target    | MISSING |                    |

### Targets (N issues)
| Target    | Status     | Notes         |
|-----------|------------|---------------|
| claude    | OK         |               |
| newagent  | INCOMPLETE | no project_path |

== Summary: X OK / Y issues found ==

5. Handler Split Audit

For commands with >300 lines in cmd/skillshare/<cmd>.go, verify the handler split convention is followed:

bash
# Find large command files
wc -l cmd/skillshare/*.go | sort -rn | head -20

Check that large commands are properly split:

SuffixExpected for large commands
_handlers.goCore logic extracted
_render.goOutput rendering separated
_tui.goTUI components isolated

Report:

  • SPLIT: Large command properly follows handler split convention
  • MONOLITH: >300 lines without split (should be refactored)
  • N/A: Small command, no split needed

6. Oplog Coverage

Verify all mutating commands have oplog instrumentation:

bash
# Find commands that modify state
grep -rn 'func handle\|func cmd' cmd/skillshare/*.go

# Check for oplog.Write calls
grep -rn 'oplog.Write' cmd/skillshare/

Mutating commands (install, uninstall, sync, update, init, collect, backup, restore, trash) should all write to oplog. Read-only commands (list, status, check, search, audit, log, version) should not.

Report:

  • INSTRUMENTED: Mutating command has oplog.Write
  • MISSING: Mutating command lacks oplog instrumentation
  • N/A: Read-only command (no oplog expected)

7. Web API Consistency

Verify internal/server/handler_*.go routes match CLI commands:

bash
# List all handler files
ls internal/server/handler_*.go | grep -v _test.go

# Check route registration in server.go
grep -n 'HandleFunc\|Handle(' internal/server/server.go

Report:

  • SYNCED: CLI command has corresponding API handler
  • CLI-ONLY: Command exists in CLI but not in Web API (may be intentional)
  • API-ONLY: API handler without CLI counterpart (unusual)

Output Format

== Skillshare Codebase Audit ==

### CLI Flags (N issues)
| Command   | Flag        | Status       |
|-----------|-------------|--------------|
| install   | --force     | OK           |
| install   | --into      | UNDOCUMENTED |

### Specs (N issues)
| Spec File            | Status      |
|----------------------|-------------|
| copy-sync-mode.md    | IMPLEMENTED |
| some-feature.md      | MISMATCH    |

### Test Coverage (N issues)
| Command   | Status  | Notes              |
|-----------|---------|--------------------|
| sync      | COVERED |                    |
| audit     | PARTIAL | missing edge cases |
| target    | MISSING |                    |

### Targets (N issues)
| Target    | Status     | Notes         |
|-----------|------------|---------------|
| claude    | OK         |               |
| newagent  | INCOMPLETE | no project_path |

### Handler Split (N issues)
| Command   | Lines | Status    | Notes              |
|-----------|-------|-----------|--------------------|
| install   | 450   | SPLIT     | 6 sub-files        |
| audit     | 320   | MONOLITH  | should split render |
| status    | 80    | N/A       |                    |

### Oplog (N issues)
| Command   | Mutating? | Status        |
|-----------|-----------|---------------|
| install   | Yes       | INSTRUMENTED  |
| trash     | Yes       | MISSING       |
| list      | No        | N/A           |

### Web API (N issues)
| Command   | CLI | API | Status   |
|-----------|-----|-----|----------|
| install   | Yes | Yes | SYNCED   |
| diff      | Yes | No  | CLI-ONLY |

== Summary: X OK / Y issues found ==

Rules

  • Read-only — never modify files, only report
  • Evidence-based — every finding must include file path and line number
  • No false positives — verify with grep before flagging
  • Scope $ARGUMENTS — if user specifies "flags", only run dimension 1; "handlers" for dimension 5, "oplog" for dimension 6, "api" for dimension 7

Frequently asked questions

What does the Skillshare Codebase Audit AI skill do?

Cross-validate CLI flags, docs, tests, and targets for consistency across the codebase. Use this skill whenever the user asks to: audit the codebase, check for consistency issues, find undocumented flags, verify test coverage, validate targets.yaml, check handler split conventions, or verify oplog instrumentation. This is a read-only audit — it reports issues but never modifies files. Use after large refactors, before releases, or whenever you suspect docs/code/tests have drifted out of sync.

Why use Skillshare Codebase Audit on TypingMind?

Because you install it once and use it with any model. Skillshare Codebase 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 Skillshare Codebase Audit in TypingMind?

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

Which AI models can use Skillshare Codebase 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 Skillshare Codebase Audit?

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

Is the Skillshare Codebase Audit AI skill free?

It is published on GitHub by JetBrains. Check the repository for licensing terms. 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 👇