New: 97,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

Codebase Wiki

by inkeep in inkeep/open-knowledge

How to work in a Codebase Wiki project (the codebase-wiki starter pack): an agent-authored, source-grounded wiki of the surrounding codebase.

GPL-3.0Auto-check passedKnowledge Management

Install Codebase Wiki

skills CLI
$ npx skills add inkeep/open-knowledge --skill codebase-wiki -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install inkeep/open-knowledge codebase-wiki --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/inkeep/open-knowledge.git skills-src && mkdir -p .claude/skills && cp -r skills-src/packages/server/assets/skills/packs/codebase-wiki .claude/skills/codebase-wiki && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
codebase-wiki
GitHub stars
4.4k
Token cost
~1.8k tokens
SKILL.md length
679 words
Files
3 (incl. references)
Skills in repo
18
Repo updated
First seen
Licence
GPL-3.0

At a glance

How to work in a Codebase Wiki project (the codebase-wiki starter pack): an agent-authored, source-grounded wiki of the surrounding codebase.

  • Tasks that involve Source-grounded notebooks
  • SKILL.md covers The shape, Generating + refreshing, The two knobs and Source-reference convention, plus 4 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
  • Tasks that involve Knowledge bases

What it does

Codebase Wiki is an agent skill from inkeep/open-knowledge. How to work in a Codebase Wiki project (the codebase-wiki starter pack): an agent-authored, source-grounded wiki of the surrounding codebase. Read when the project has a wiki/ knowledge base with architecture/, modules/, flows/, concepts/, and guides/ sections plus wiki/OVERVIEW.md, or when asked to generate or refresh a wiki of this codebase. Carries the per-folder rules and freshness + log discipline, summarizes the audience/depth knobs and source-reference convention, and bundles the full generate/refresh…

Its SKILL.md is about 1.8k tokens, which your agent loads only when the skill is triggered. The skill folder holds 3 other files, including reference files (for example `plugin.json` and `references/generate-and-refresh.md`). Compatibility notes: Any agent host with the OpenKnowledge MCP server configured. Installed project-local by ok seed --pack codebase-wiki.

It sits in Knowledge Management, covering Source-grounded notebooks, Knowledge bases and LLM wikis. The repository describes itself as: Beautiful, AI-native markdown IDE and LLM wiki. The licence is GPL-3.0.

When your agent uses it

  • Tasks that involve Source-grounded notebooks
  • Tasks that involve Knowledge bases
  • Tasks that involve LLM wikis

Example prompts

  • “/codebase-wiki”

Requirements

  • Compatibility (from SKILL.md): Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack codebase-wiki`.

What it can do on your machine

Read from SKILL.md and the folder at commit cf9b84c. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are markdown).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

  • Compatibility

    Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack codebase-wiki`.

    From compatibility in the SKILL.md frontmatter.

Context cost

Codebase Wiki loads about 1.8k tokens when it runs, and up to ~5.1k if it reads all its reference files. Until then it costs about 160 tokens; SKILL.md has 679 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~160
When it runs · the whole SKILL.md, loaded when a task matches
~1.8k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~5.1k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from inkeep/open-knowledge at commit cf9b84c, republished under its GPL-3.0 licence (© inkeep). 679 words, ~1,840 tokens.

Download SKILL.mdSave it as .claude/skills/codebase-wiki/SKILL.md (or your agent's skills folder). This skill also uses 2 other files; get the full folder from GitHub.
name
codebase-wiki
description
How to work in a Codebase Wiki project (the `codebase-wiki` starter pack): an agent-authored, source-grounded wiki of the surrounding codebase. Read when the project has a `wiki/` knowledge base with `architecture/`, `modules/`, `flows/`, `concepts/`, and `guides/` sections plus `wiki/OVERVIEW.md`, or when asked to generate or refresh a wiki of this codebase. Carries the per-folder rules and freshness + log discipline, summarizes the audience/depth knobs and source-reference convention, and bundles the full generate/refresh procedure in `references/`. Complements the platform `open-knowledge` skill; does not replace it.
compatibility
Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack codebase-wiki`.
metadata.pack
codebase-wiki
metadata.author
Inkeep
metadata.repository
https://github.com/inkeep/open-knowledge-skills

Codebase Wiki pack — how to work here

This project holds an agent-authored wiki of a codebase — DeepWiki, but living in the repo. A coding agent reads the source and writes a navigable, diagram-rich, source-grounded wiki as markdown under wiki/. It is version-controlled and diffable, private by default, human+agent co-editable, renders in OK's live preview, and doubles as durable grounding context for future agent sessions. There is no separate Q&A surface — Q&A is "the OK-grounded agent + search".

This skill is pack guidance. The platform /open-knowledge skill (read/write/preview/linking/grounding rules) still governs every markdown operation — this layers the wiki workflow on top.

The shape

wiki/
  OVERVIEW.md     hub: what it is, a big-picture architecture diagram, a nav map to every section.
                  Frontmatter carries `profile` (audience/depth) + `source_commit` (freshness anchor).
  log.md          append-only generation / refresh audit trail
  architecture/   system boundaries, layers, subsystems, cross-cutting concerns + diagrams
  modules/        one page per package / module: purpose, entry points, key files, deps
  flows/          key end-to-end flows as sequence / flow diagrams + narrative
  concepts/       glossary: atomic pages for domain terms / core abstractions
  guides/         task-oriented "how / where do I change X" (filled at depth >= standard)

Generating + refreshing

Don't free-hand it — read references/generate-and-refresh.md and follow the phased, STOP-gated procedure. It auto-detects mode: a stubbed OVERVIEW.md (empty source_commit) → generate (survey → overview → architecture → modules → flows → concepts → link-graph audit); a stamped source_commit → refresh (diff source_commit..HEAD, update only affected pages, re-stamp).

Two toolsets. Read source code with NATIVE tools (Read/Grep/Glob/Bash) — OK MCP does not index non-markdown source. Author and audit the wiki with OK MCP verbs (write/edit for pages, links/search for the graph). Never hand-write wiki markdown with native Write/Edit.

The two knobs

Two natural-language knobs, read from the user's request (e.g. "build the wiki, public and exhaustive") and recorded in OVERVIEW.md frontmatter (profile: <audience>/<depth>) so refreshes stay consistent:

  • audience — internal (default) or public. public means polished prose, no secrets / internal infra / ticket numbers, and GitHub-URL source references.
  • depth — tour | standard (default) | exhaustive. Scales coverage from OVERVIEW + architecture + top flows up through per-package module pages, concepts, and task guides.

references/generate-and-refresh.md is the authoritative source for exactly how each knob shapes the output — read it before generating.

Source-reference convention

  • Intra-wiki navigation → OK doc links — they build the backlink / hub / orphan graph, so link liberally; density is how the wiki stays navigable.
  • Code references → relative links + symbol code-spans (internal) or GitHub blob URLs (public). Source-file links stay out of the navigation graph (links tracks only .md/.mdx edges, so they never show as graph dead-links or orphans) — but a wrong-depth path still surfaces in the write/edit brokenLinks response (no-such-file, or unresolvable if it overshoots the content root), so count the ../ hops from the page's folder. Never invent paths — reference only files you actually read.

The full rules — the GitHub-URL / relative fallback, the #Lxx caveat, and the exact code-span shape — live in references/generate-and-refresh.md.

Show full SKILL.md (299 more words)Show less

Per-folder rules

architecture/ — One page per architectural area (boundaries, layers, subsystems, cross-cutting concerns). Each: a mermaid system-context or component diagram, key components (with source refs), and the design decisions behind them. Uses the architecture-page template. At depth: tour, modules fold in here.

modules/ — One page per package / module: purpose, responsibilities, public API / entry points, key files (linked per the convention), dependencies, and flows it participates in. Uses the module-page template. Skipped at tour; sub-module depth scales with the knob.

flows/ — Key end-to-end sequences as mermaid sequence / flow diagrams + narrative. Uses the flow-page template; add a Failure modes section at exhaustive. Link every module and concept the flow crosses.

concepts/ — Atomic glossary pages (one term each): definition, why it matters, where it lives in the code. Uses the concept-page template. Keep small and densely cross-linked so each concept becomes a hub.

guides/ — Task-oriented "how / where do I change X" walkthroughs: goal, steps, relevant code, gotchas. Uses the guide-page template. Populated at standard, rich at exhaustive, thin/empty at tour.

Freshness discipline (MUST)

OVERVIEW.md frontmatter carries source_commit — the git HEAD the wiki was last generated/refreshed against. It is the freshness anchor: refresh mode diffs source_commit..HEAD to update only the affected pages, then re-stamps it. Always re-stamp source_commit after a generate or refresh run — a stale anchor silently breaks incremental refresh.

Log discipline (MUST)

wiki/log.md is an append-only audit trail. Append one dated entry per generation or refresh run — one per run, not per page. Reference touched pages as markdown links ([Server](./modules/server.md)) so they register in the backlink graph. Entry shape:

markdown
## YYYY-MM-DD: <generate | refresh>

- Profile: <audience>/<depth>
- source_commit: <short-sha> (was <prev-sha> on refresh)
- Coverage: <sections / packages written or updated>
- Pages: [Overview](./OVERVIEW.md), [Server](./modules/server.md), ...

Templates

Each folder ships a starter template (architecture-page, module-page, flow-page, concept-page, guide-page). Create with write({ document: { path, template: "<name>" } }). Templates carry only structure (headings + frontmatter scaffold); what each section is for is described above and in references/generate-and-refresh.md, not repeated inside document bodies.

© inkeep, GPL-3.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 2 other files (references) in packages/server/assets/skills/packs/codebase-wiki of inkeep/open-knowledge.

  • SKILL.md
  • plugin.json
  • references/generate-and-refresh.md

Open the folder on GitHubat commit cf9b84c

Compare with similar skills

Codebase Wiki next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Codebase Wiki compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Codebase Wiki this skillinkeep/open-knowledge4.4k—~1.8kAutomated safety check: PassGPL-3.0
LLM Wiki Knowledge GraphEgonex-AI/Understand-Anything85k1 repos~1.5kAutomated safety check: PassMIT
Learn From Materialsdmoshehun-prog/learn-from-materials902—~7.9kAutomated safety check: PassMIT
LLM Wikilewislulu/llm-wiki-skill655—~3.7kAutomated safety check: PassNone
Wiki Builderrohitg00/pro-workflow2.9k—~1kAutomated safety check: PassNone
Arkon Editnduckmink/arkon1.5k—~1.6kAutomated safety check: PassCustom licence

Similar skills

  • LLM Wiki Knowledge Graph

    Egonex-AI/Understand-Anything

    Detects a Karpathy-pattern LLM wiki and builds an interactive knowledge graph with entities, implicit relationships and topic clusters.

    85k GitHub starsUsed in 1 repo~1.5k tokens
    Knowledge ManagementAuto-check passed

  • Learn From Materials

    dmoshehun-prog/learn-from-materials

    Turns books, PDFs, slides and web pages into a source-grounded knowledge base and an interactive learning page in English or Chinese, with quizzes, relationship maps and reusable methodology notes.

    902 GitHub stars~7.9k tokensUpdated 6 days ago
    Knowledge ManagementAuto-check passed

  • LLM Wiki

    lewislulu/llm-wiki-skill

    Build and maintain a Karpathy-style LLM knowledge base — a self-compiling Obsidian markdown wiki where an Agent ingests raw sources, compiles cross-linked concept/entity/summary pages, answers…

    655 GitHub stars~3.7k tokensUpdated 5 mo ago
    Knowledge ManagementAuto-check passed

  • Wiki Builder

    rohitg00/pro-workflow

    Start, structure, and grow a persistent research wiki indexed in pro-workflow's SQLite knowledge base.

    2.9k GitHub stars~1k tokensUpdated 8 days ago
    Knowledge ManagementAuto-check passed

  • Arkon Edit

    nduckmink/arkon

    Propose or directly apply edits to Arkon wiki pages, including proposing brand new pages.

    1.5k GitHub stars~1.6k tokensUpdated 4 mo ago
    Knowledge ManagementAuto-check passed

  • Research Wiki Builder

    dair-ai/dair-academy-plugins

    Creates and maintains configurable research wikis: scaffold a folder, add sources, compile pages and indexes, and file query answers back.

    614 GitHub stars~1.3k tokensUpdated 2 mo ago
    Knowledge ManagementAuto-check passed

More from inkeep/open-knowledge

All 18 skills in this repo

  • Open Knowledge Write Skill

    inkeep/open-knowledge

    A skill your agent uses when the user wants to create, author, write, or design a new Agent Skill (a SKILL.md) — for OpenKnowledge or for their editors — including requests like 'help me write a…

    4.4k GitHub stars~3.7k tokensUpdated today
    Auto-check passed

  • Open Knowledge Discovery

    inkeep/open-knowledge

    Read when the user asks what OpenKnowledge is, wants to install it on a repository, wants to open or preview a single markdown file that is not part of an OpenKnowledge project, wants to share an…

    4.4k GitHub stars~2k tokensUpdated today
    Auto-check passed

  • Write A Postmortem

    inkeep/open-knowledge

    Write a blameless incident postmortem under postmortems/ following the Google SRE shape — evidence-based timeline, trigger vs root cause vs symptom, contributing factors, what went well, and…

    4.4k GitHub stars~4.4k tokensUpdated today
    Auto-check passed

  • Open Knowledge

    inkeep/open-knowledge

    Authoritative agent-runtime contract for working inside an OpenKnowledge project — a markdown-CRDT knowledge base exposed over MCP.

    4.4k GitHub stars~4.7k tokensUpdated today
    Auto-check passed

  • Consolidate Notes

    inkeep/open-knowledge

    Promote existing research into a stable-status canonical article under articles/ in a Knowledge Base project (the knowledge-base starter pack).

    4.4k GitHub stars~2.3k tokensUpdated today
    Auto-check passed

  • Frame A Proposal

    inkeep/open-knowledge

    Frame a new design proposal (RFC-shape) under proposals/ — problem before solution, named beneficiary and observable change, real alternatives, honest drawbacks, and a live open-questions backlog.

    4.4k GitHub stars~3.6k tokensUpdated today
    Auto-check passed

Categories

Questions about Codebase Wiki

What does Codebase Wiki do?

How to work in a Codebase Wiki project (the codebase-wiki starter pack): an agent-authored, source-grounded wiki of the surrounding codebase. Codebase Wiki is an agent skill from inkeep/open-knowledge. How to work in a Codebase Wiki project (the codebase-wiki starter pack): an agent-authored, source-grounded wiki of the surrounding codebase.

When should I use Codebase Wiki?

Codebase Wiki fits situations like: tasks that involve Source-grounded notebooks; tasks that involve Knowledge bases; tasks that involve LLM wikis.

How do I install Codebase Wiki in Claude Code?

Run `npx skills add inkeep/open-knowledge --skill codebase-wiki -a claude-code`. Or copy the skill folder (packages/server/assets/skills/packs/codebase-wiki in inkeep/open-knowledge) into .claude/skills/codebase-wiki in your project. Claude Code loads it when a task matches its description.

How do I install Codebase Wiki in Codex?

Run `npx skills add inkeep/open-knowledge --skill codebase-wiki -a codex`. Or copy the skill folder (packages/server/assets/skills/packs/codebase-wiki in inkeep/open-knowledge) into .agents/skills/codebase-wiki in your project. Codex loads it when a task matches its description.

Can I use Codebase Wiki in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add inkeep/open-knowledge --skill codebase-wiki -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/codebase-wiki, .gemini/skills/codebase-wiki, .github/skills/codebase-wiki and .opencode/skills/codebase-wiki in your project.

What does Codebase Wiki need to run?

SKILL.md names no scripts, command-line tools or credentials: Codebase Wiki is instructions for the agent only. Compatibility (from SKILL.md): Any agent host with the OpenKnowledge MCP server configured. Installed project-local by `ok seed --pack codebase-wiki`..

Does Codebase Wiki access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Codebase Wiki safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Codebase Wiki use?

Codebase Wiki is published under the GPL-3.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Codebase Wiki use?

About 1.8k tokens (SKILL.md is roughly 7.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 3.3k tokens, read only when the agent opens those files.

What are the alternatives to Codebase Wiki?

Skills that share tags, products or a category with Codebase Wiki: LLM Wiki Knowledge Graph (Egonex-AI/Understand-Anything, 85k stars), Learn From Materials (dmoshehun-prog/learn-from-materials, 902 stars), LLM Wiki (lewislulu/llm-wiki-skill, 655 stars) and Wiki Builder (rohitg00/pro-workflow, 2.9k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Codebase Wiki?

inkeep (a GitHub organization) maintains it in inkeep/open-knowledge, which has 4,407 GitHub stars. The repository holds 18 skills in this directory. The repository was last updated on October 7, 2026.

Source: inkeep/open-knowledge on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.