project-compass

A way to record the practical knowledge of a codebase in COMPASS.md files placed beside its major areas. These files explain why the code is shaped the way it is, important traps, and how different areas connect.

In plain words
What is it for?
Mapping an existing repository, documenting major areas, refreshing documentation after significant changes, and answering why a part of the codebase works a certain way.
Why use it?
It preserves details that may exist only in developers' memories, so future work does not depend on asking the same people or guessing from code alone.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/sjarmak/coding-agent-workflows/project-compass
Any agent
npx skills add sjarmak/coding-agent-workflows --skill project-compass
Clone the repo
git clone --depth 1 https://github.com/sjarmak/coding-agent-workflows

Made for: Claude Code, Codex.

Per session 69 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,618 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00069 $0.01618
Opus 5 $0.00034 $0.00809
Sonnet 5 $0.00014 $0.00324
Haiku 4.5 $0.00007 $0.00162

Measured 2d ago against content hash 540ec2ad2346, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

project-compass scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

The scan reads SKILL.md. This mod also ships 1 executable file (compass-hash.mjs), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

source/skills/project-compass/SKILL.md · 136 lines

How it starts

The opening of the file, as written. The whole thing — 136 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Project Compass

Map the tribal knowledge of a codebase into per-area COMPASS.md files: the why and the gotchas, the things that aren't visible in the code's surface and that otherwise live only in someone's head. One map per major area, living next to the code it describes. Inspired by mapping tribal knowledge across large codebases (per Meta's data-pipeline knowledge-mapping work).

Compass files are the dense layer. They exist so that AGENTS.md and memory stay thin — see the context-layering practice for the boundary. AGENTS.md only indexes compass files; it never copies their content.

When to use

  • "Map this codebase" / "generate compass files" / "set up codebase compass"
  • "Refresh the compass for src/api" after that area changed materially
  • During project-init, to seed maps for the largest areas
  • The user asks "why is this area shaped this way?" (read the existing compass first)

ZFC boundary

This skill is AI-orchestration. Mechanism gathers raw signal; the model writes every word of the map. Do not template-fill prose from heuristics — a compass is a judgment about what matters in an area, which is exactly what a model does well and a regex does not.

  • Mechanism: file discovery, directory sizing, content-hashing, reading source, writing the file, updating the index. The hash is computed by compass-hash.mjs (ships in this skill dir), never by the model.
  • Model: purpose, what counts as a key entry point, which constraints are non-obvious, which gotchas are load-bearing.

How it works

Phase 1 — Pick the areas (mechanism)

Identify the major areas worth a map. Reuse codebase-onboarding reconnaissance for structure detection. An "area" is a directory that is both substantial (meaningful share of the code) and cohesive (one responsibility). Skip vendored, generated, and build directories. For a small repo, one root-level compass may be enough; for a monorepo, one per top-level package.

Confirm the candidate area list with the user before generating — generating a map per leaf directory is the failure mode to avoid.

Read the full file on GitHub · 136 lines

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 136 lines · 69 tokens per session scan A 540ec2ad2346

Subscribe to this mod's changes

project-compass is a skill published in the GitHub repository sjarmak/coding-agent-workflows (2 stars, last pushed 1mo ago), licensed MIT. It adds 69 tokens to every session and 1,618 once invoked, about $0.0003 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

browser-trace

Capture a full DevTools-protocol trace of any browser automation — CDP firehose, screenshots, and DOM dumps — then bisect the stream into per-page searchable buckets. Use when the user wants to debug a failed run, audit network/console/DOM activity, attach a trace to an in-progress session, or feed structured per-page…

mxyhi/ok-skills · 88 tokens

planning-with-files

Manus-style persistent file-based planning for AI coding agents: keeps taskplan.md, findings.md, and progress.md on disk so work survives context loss and /clear. Use when asked to plan out, break down, or organize a multi-step project, research task, or any work requiring 5+ tool calls. Supports automatic session…

mxyhi/ok-skills · 76 tokens

ai-elements

Build AI chat interfaces using ai-elements components — conversations, messages, tool displays, prompt inputs, and more. Use when the user wants to build a chatbot, AI assistant UI, or any AI-powered chat interface.

mxyhi/ok-skills · 46 tokens

exa-search

Use Exa MCP for current web, code/docs, company, people, and page-fetch research. Prefer current hosted tool schemas and note deprecated tools.

mxyhi/ok-skills · 33 tokens

ontoly-software-graph

Use Ontoly's deterministic Software Graph and MCP capabilities for repository architecture, request tracing, dependency analysis, configuration lookup, and impact analysis before falling back to source search.

mxyhi/ok-skills · 40 tokens

product-decision-agent

中文产品决策 Agent。用于中国大陆互联网产品、运营、增长、商业化、数据、项目推进和组织协作场景:产品规划、需求分析、PRD、需求优先级、排期、版本规划、Roadmap、MVP、灰度、上线、迭代、增长停滞、拉新、投放、渠道、裂变、CAC、LTV、ROI、留存、转化、DAU/MAU、GMV、漏斗、社区运营、内容供给、创作者、用户运营、活动运营、私域、会员、定价、指标异常、数据口径、埋点、A/B…

mxyhi/ok-skills · 265 tokens