Skills

Omh Codebase Uml

[omh] Architecture picture of a codebase: turn a repository into one readable...

Install

npx skills add rlaope/oh-my-hermes --skill omh-codebase-uml -g -a claude-code -y
Category
Engineering
Updated
3d ago
License
MIT
Context cost
Mediumabout 2,060 tokens
Runs scripts
No, instructions only

What it does

[omh] Architecture picture of a codebase: turn a repository into one readable, interface-level PlantUML architecture picture - packages or modules, the public symbols other units actually import, bounded import edges - and get it rendered to a single PNG a chat surface can show. Use when the user says: codebase-uml, codebase uml, uml, plantuml, uml diagram, class diagram, package diagram, module diagram.

Codebase Uml

This is an OMH codebase-uml workflow skill, projected for Agent Skills hosts (Claude Code, Codex, Cursor, opencode, OpenClaw, pi).

Why This Exists

codebase-uml exists so 'visualize our codebase' produces one deterministic, readable picture instead of a hand-drawn guess: the interface each unit exposes is ranked by who imports it, the layout is bounded before PlantUML sees it, and every omission the bounding made is printed on the image.

Do Not Use When

  • The user wants the local code index refreshed or a task-scoped handoff pack, not a picture; use omh-codegraph-refresh.
  • The user wants a narrative first-read tour, reading path, or glossary; use omh-codebase-onboarding.
  • The user wants a summary card, thumbnail, or explainer image of a PR, meeting, or release rather than a structural diagram; use omh-image-cards.

Examples

Good example:

  • Prompt: Visualize our codebase and drop the picture here so the new teammate can see how the routing package fits.
  • Expected behavior: Run omh codegraph uml --focus src/routing --output .omh/uml/routing.puml, render with the plan's command, attach the PNG, and read back the legend (units shown, folded, edges pruned).
  • Why: The request is a structural picture of one area for a chat surface, which is exactly the bounded diagram this workflow produces.

Bad example:

  • Prompt: Just sketch what you think the architecture looks like from the README.
  • Expected behavior: Decline to draw from memory; generate the diagram from the tree with omh codegraph uml or say the renderer is missing and name the install step.
  • Why: A diagram not derived from the actual tree misleads more than no diagram.

Completion Checklist

Read the whole SKILL.md on GitHub

More in Engineering