Agent skill

Codexqa Code Wiki

by openqa-cn in openqa-cn/codexqa

Builds a local architecture wiki for a repository from the CodexQA symbol graph (no model needed): modules, who calls whom and how often, reading paths, and one self-contained HTML page.

Apache-2.0Auto-check passedKnowledge Management

Install Codexqa Code Wiki

skills CLI
$ npx skills add openqa-cn/codexqa --skill codexqa-code-wiki -a claude-code

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

GitHub CLI
$ gh skill install openqa-cn/codexqa codexqa-code-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/openqa-cn/codexqa.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/codexqa-code-wiki .claude/skills/codexqa-code-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
codexqa-code-wiki
GitHub stars
152
Token cost
~1.3k tokens
SKILL.md length
526 words
Files
30 (incl. scripts, references, assets)
Skills in repo
14
Repo updated
First seen
Licence
Apache-2.0

At a glance

Builds a local architecture wiki for a repository from the CodexQA symbol graph (no model needed): modules, who calls whom and how often, reading paths, and one self-contained HTML page.

  • Works in 4 steps: Brief. Run node /scripts/wiki.mjs brief… → Notes. Read references/notes.md, then fill → Build. Run node /scripts/wiki.mjs build… → …
  • The user mentions codexqa-code-wiki
  • SKILL.md covers Documents (load on demand), Default flow, Scenario routing and Rules
  • Runs JavaScript scripts from its folder; calls node

What it does

Codexqa Code Wiki is an agent skill from openqa-cn/codexqa. Builds a local architecture wiki for a repository from the CodexQA symbol graph (no model needed): modules, who calls whom and how often, reading paths, and one self-contained HTML page. Use when the user mentions codexqa-code-wiki, code-wiki, wiki, knowledge graph, architecture wiki, module map, reading guide, 代码知识图谱, 架构 Wiki, 模块地图, 阅读导览, wiki inputs, --no-llm, community detection, 社区检测, HTML 报告, or asks to map modules / generate a repo wiki without an LLM. Not change review (that is codexqa-code-analyzer), not…

Its SKILL.md is about 1.3k tokens, which your agent loads only when the skill is triggered. The skill folder holds 33 other files, including scripts, reference files and assets (for example `KNOWN_LIMITATIONS.md`, `KNOWN_LIMITATIONS.zh-CN.md` and `README.md`). Compatibility notes: Requires Node.js = 18 and the codexqa CLI (npm i -g @openqa-cn/codexqa) on PATH. Index and wiki inputs need no LLM. Data lives in ~/.codexqa/.

It sits in Knowledge Management, covering Static analysis and SAST, Code review and HTML artifacts. The repository describes itself as: codexqa: 11 local-first Agent Skills for Cursor, Claude Code, Codex & OpenClaw — change impact analysis, AI code review, defect scan, testcase generation, browser replay & RCA. The licence is Apache-2.0.

When your agent uses it

  • The user mentions codexqa-code-wiki
  • Knowledge graph
  • Architecture wiki
  • Community detection

Example prompts

  • “Use the codexqa-code-wiki skill to build a local architecture wiki for a repository from the CodexQA symbol graph (no model needed): modules, who…”
  • “/codexqa-code-wiki”

Requirements

  • Node.js
  • Compatibility (from SKILL.md): Requires Node.js >= 18 and the `codexqa` CLI (`npm i -g @openqa-cn/codexqa`) on PATH. Index and `wiki inputs` need no LLM. Data lives in ~/.codexqa/.

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

  1. Brief. Run node /scripts/wiki.mjs brief . It indexes
  2. Notes. Read references/notes.md, then fill
  3. Build. Run node /scripts/wiki.mjs build . If it prints
  4. Deliver. Tell the user the printed file path plus two or three lines on

What it can do on your machine

Read from SKILL.md and the folder at commit 7839542. 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

    Ships 6 files in scripts/ (JavaScript, from the files we listed), which the agent can run.

    Shell commands in SKILL.md call:

    • node

    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

    Requires Node.js >= 18 and the `codexqa` CLI (`npm i -g @openqa-cn/codexqa`) on PATH. Index and `wiki inputs` need no LLM. Data lives in ~/.codexqa/.

    From compatibility in the SKILL.md frontmatter.

Context cost

Codexqa Code Wiki loads about 1.3k tokens when it runs, and up to ~5.1k if it reads all its reference files. Until then it costs about 177 tokens; SKILL.md has 526 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~177
When it runs · the whole SKILL.md, loaded when a task matches
~1.3k
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); the scripts in this folder are not scanned.

SKILL.md

The full file from openqa-cn/codexqa at commit 7839542, republished under its Apache-2.0 licence (© openqa-cn). 526 words, ~1,268 tokens.

Download SKILL.mdSave it as .claude/skills/codexqa-code-wiki/SKILL.md (or your agent's skills folder). This skill also uses 29 other files; get the full folder from GitHub.
name
codexqa-code-wiki
description
Builds a local architecture wiki for a repository from the CodexQA symbol graph (no model needed): modules, who calls whom and how often, reading paths, and one self-contained HTML page. Use when the user mentions codexqa-code-wiki, code-wiki, wiki, knowledge graph, architecture wiki, module map, reading guide, 代码知识图谱, 架构 Wiki, 模块地图, 阅读导览, wiki inputs, --no-llm, community detection, 社区检测, HTML 报告, or asks to map modules / generate a repo wiki without an LLM. Not change review (that is codexqa-code-analyzer), not CodexQA evidence-pack HTML review (that is codexqa-code-reviewer), and not SAST+agent code-risk scan reports (that is codexqa-defect-analyzer). Former skill name: code-wiki.
compatibility
Requires Node.js >= 18 and the `codexqa` CLI (`npm i -g @openqa-cn/codexqa`) on PATH. Index and `wiki inputs` need no LLM. Data lives in ~/.codexqa/.
license
Apache-2.0
metadata.author
open-source
metadata.version
2.0.0
metadata.open-standard
agentskills

Code Wiki

Three commands, one file to write:

text
node <skill>/scripts/wiki.mjs brief <repo>   # index + export facts + print the brief
  → you write .codexqa-wiki/<repo>/notes.json  # names and sentences only
node <skill>/scripts/wiki.mjs build <repo>   # validate + render one HTML file

The script owns every fact on the page: modules, sizes, call counts, groups, the architecture diagram, public symbols, files, links, search. You own the words: what the repo is, what each module does, and which reading path fits which task. You never edit HTML, CSS, or diagrams.

<skill> is this skill's directory. <repo> is a local checkout (preferred). README.md / README.zh-CN.md are for humans; do not load them.

Documents (load on demand)

FileLoad when
SKILL.md (this file)always
references/notes.mdbefore writing notes.json
references/playbook.mdone module only, index problems, persisting for the Web UI
references/cli.mdcodexqa missing, PATH, repo ids, maintenance

Default flow

  1. Brief. Run node <skill>/scripts/wiki.mjs brief <repo>. It indexes incrementally, exports codexqa wiki inputs, and writes .codexqa-wiki/<repo>/ with inputs.json, meta.json, brief.md, and a notes.json scaffold (kept if it already exists). Read the printed brief: groups, suggested paths, and per module its files, calls, callers, public symbols, and key flows.
  2. Notes. Read references/notes.md, then fill notes.json. Every P01-style id and group id in it must exist in the brief. Write 简体中文 unless the user asked for English ("lang": "en").
  3. Build. Run node <skill>/scripts/wiki.mjs build <repo>. If it prints error: lines, fix those fields and rerun; they name the field and the fix. check <repo> validates without writing HTML.
  4. Deliver. Tell the user the printed file path plus two or three lines on what the wiki says. Do not paste the HTML or open it in chat.

The user only wants a quick look → build <repo> --draft right after brief. The page uses rule-based names and says it is a draft. Offer to write the notes afterwards.

Useful flags: brief --limit 8 (large repos), brief --lang en, brief --skip-index (index is fresh), build --out FILE, build --source-url 'https://host/repo/blob/{commit}/{path}' (file links when the remote is not GitHub / GitLab / Gitee / Bitbucket).

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

Scenario routing

User is asking…Do
What is this repo / module map / architecture wiki / knowledge graphDefault flow
Where should I start reading / onboarding pathDefault flow; put the effort into guides
What does module X do / who does it talk toAnswer from brief.md; deeper digest in playbook Explain one module
Store a rule-only wiki for the CodexQA Web UIplaybook Persist rule-only wiki
brief failed / empty export / wrong branchplaybook Index health

Change review, callers of a symbol, test gaps, and stack traces belong to codexqa-code-analyzer.

Rules

  • Facts come only from this run's export. Do not add modules, calls, or responsibilities that the brief does not support; do not use the README or a website as evidence for a module's role.
  • A reading path follows real calls: each step must call or be called by the next. build rejects anything else and lists the valid neighbours.
  • Standalone modules (no calls to or from other modules) get a name and a role, never a layer.
  • Write for someone who just cloned the repo. No internal field names (deps, cross_community, called_by, wiki inputs); build rejects them.
  • Do not run codexqa wiki without --no-llm, wiki embed, or query wiki. Those call a model or need model-written pages.
  • Do not hand-edit the generated HTML. Change notes.json and rebuild.

© openqa-cn, Apache-2.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 29 other files (scripts, references, assets) in skills/codexqa-code-wiki of openqa-cn/codexqa.

  • SKILL.md
  • KNOWN_LIMITATIONS.md
  • KNOWN_LIMITATIONS.zh-CN.md
  • README.md
  • README.zh-CN.md
  • assets/wiki.css
  • assets/wiki.js
  • package.json
  • references/cli.md
  • references/notes.md
  • references/playbook.md
  • scripts/lib/layout.mjs
  • scripts/lib/model.mjs
  • scripts/lib/notes.mjs
  • scripts/lib/render.mjs
  • scripts/lib/repo.mjs
  • scripts/lib/strings.mjs
  • … and 13 more

Open the folder on GitHubat commit 7839542

Compare with similar skills

Codexqa Code 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.

Codexqa Code Wiki compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Codexqa Code Wiki this skillopenqa-cn/codexqa152—~1.3kAutomated safety check: PassApache-2.0
Graphxwtro0tk1t-cloud/harness265—~1.1kAutomated safety check: PassNone
Learning Visualization Skillmingchen666/Reviva236—~1.1kAutomated safety check: PassNone
Understand Diff AnalysisEgonex-AI/Understand-Anything85k1 repos~1.4kAutomated safety check: PassMIT
Trailmark Graph Evolutiontrailofbits/skills7.4k—~3.4kAutomated safety check: PassCC-BY-SA-4.0
Code Review Graph Buildertirth8205/code-review-graph32k—~295Automated safety check: PassMIT

Similar skills

  • Graph

    xwtro0tk1t-cloud/harness

    Manage code knowledge graphs via code-review-graph (CRG). An agent skill from xwtro0tk1t-cloud/harness.

    265 GitHub stars~1.1k tokensUpdated 5 mo ago
    Knowledge ManagementAuto-check passed
  • Generate single-file HTML visual explanations for learning and review.

    236 GitHub stars~1.1k tokensUpdated 16 days ago
    Knowledge ManagementAuto-check passed
  • Understand Diff Analysis

    Egonex-AI/Understand-Anything

    Reads your git changes or a pull request against a prebuilt knowledge graph of the project to explain what changed, which components are affected and what is risky.

    85k GitHub starsUsed in 1 repo~1.4k tokens
    DevelopmentAuto-check passed
  • Trailmark Graph Evolution

    trailofbits/skills

    Official

    Compares Trailmark code graphs at two snapshots, such as commits, tags or directories, to surface attack paths, blast radius and taint changes that text diffs miss.

    7.4k GitHub stars~3.4k tokensUpdated 5 days ago
    SecurityAuto-check passed
  • Code Review Graph Builder

    tirth8205/code-review-graph

    Builds or incrementally updates the code-review knowledge graph for a repository and reports whether the build succeeded, partly or failed.

    32k GitHub stars~295 tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Scan Code

    microsoft/power-platform-skills

    Official

    Scans a Power Pages site project for security issues in source code and dependencies.

    967 GitHub stars~3.4k tokensUpdated yesterday
    DevelopmentAuto-check: notes

More from openqa-cn/codexqa

All 14 skills in this repo
  • Diagnoses exception root causes from stack traces, logs, call-chain dumps, and debug output using the CodexQA CLI for structured repo analysis.

    152 GitHub stars~2.6k tokensUpdated 4 days ago
    Auto-check passed
  • Constructs test data against real backends and writes it back into test cases as executable preconditions.

    152 GitHub stars~4.8k tokensUpdated 4 days ago
    Auto-check passed
  • Codexqa Skill Router

    openqa-cn/codexqa

    Auto-routes a user request to the matching codexqa skill, then ensures that skill is on disk and follows its SKILL.md.

    152 GitHub stars~2k tokensUpdated 4 days ago
    Auto-check passed
  • Generates test plans and test cases from local requirements for APP, Web, and server.

    152 GitHub stars~3.6k tokensUpdated 4 days ago
    Auto-check passed
  • Catalog

    openqa-cn/codexqa

    Constructs catalog products (standard or limited), catalog orders, and account-credit enrollment, including product-then-credit scenes.

    152 GitHub stars~514 tokensUpdated 4 days ago
    Auto-check passed
  • Codexqa Change Analysis

    openqa-cn/codexqa

    Change-impact analysis for one diff: use CodexQA diff indexing (index --diff-base tags nodes and files add / change / delete, then change-groups / symbol-diff / file-base) to write one HTML report…

    152 GitHub stars~3.1k tokensUpdated 4 days ago
    Auto-check passed

Questions about Codexqa Code Wiki

What does Codexqa Code Wiki do?

Builds a local architecture wiki for a repository from the CodexQA symbol graph (no model needed): modules, who calls whom and how often, reading paths, and one self-contained HTML page. Codexqa Code Wiki is an agent skill from openqa-cn/codexqa. Builds a local architecture wiki for a repository from the CodexQA symbol graph (no model needed): modules, who calls whom and how often, reading paths, and one self-contained HTML page.

When should I use Codexqa Code Wiki?

Codexqa Code Wiki fits situations like: the user mentions codexqa-code-wiki; knowledge graph; architecture wiki; community detection.

How do I install Codexqa Code Wiki in Claude Code?

Run `npx skills add openqa-cn/codexqa --skill codexqa-code-wiki -a claude-code`. Or copy the skill folder (skills/codexqa-code-wiki in openqa-cn/codexqa) into .claude/skills/codexqa-code-wiki in your project. Claude Code loads it when a task matches its description.

How do I install Codexqa Code Wiki in Codex?

Run `npx skills add openqa-cn/codexqa --skill codexqa-code-wiki -a codex`. Or copy the skill folder (skills/codexqa-code-wiki in openqa-cn/codexqa) into .agents/skills/codexqa-code-wiki in your project. Codex loads it when a task matches its description.

Can I use Codexqa Code 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 openqa-cn/codexqa --skill codexqa-code-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/codexqa-code-wiki, .gemini/skills/codexqa-code-wiki, .github/skills/codexqa-code-wiki and .opencode/skills/codexqa-code-wiki in your project.

What does Codexqa Code Wiki need to run?

Going by SKILL.md and its folder, Codexqa Code Wiki needs JavaScript for the scripts in its folder and the command-line tools its instructions call (node). Our summary lists: Node.js. Compatibility (from SKILL.md): Requires Node.js >= 18 and the `codexqa` CLI (`npm i -g @openqa-cn/codexqa`) on PATH. Index and `wiki inputs` need no LLM. Data lives in ~/.codexqa/. .

Does Codexqa Code 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 Codexqa Code 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. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.

What licence does Codexqa Code Wiki use?

Codexqa Code Wiki is published under the Apache-2.0 licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Codexqa Code Wiki use?

About 1.3k tokens (SKILL.md is roughly 5.1k 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.9k tokens, read only when the agent opens those files.

What are the alternatives to Codexqa Code Wiki?

Skills that share tags, products or a category with Codexqa Code Wiki: Graph (xwtro0tk1t-cloud/harness, 265 stars), Learning Visualization Skill (mingchen666/Reviva, 236 stars), Understand Diff Analysis (Egonex-AI/Understand-Anything, 85k stars) and Trailmark Graph Evolution (trailofbits/skills, 7.4k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Codexqa Code Wiki?

openqa-cn (a GitHub organization) maintains it in openqa-cn/codexqa, which has 152 GitHub stars. The repository holds 14 skills in this directory. The repository was last updated on October 3, 2026.

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