Code Wiki

Skill: Code Wiki

When to trigger

Invoke this skill when the user:

• Types /codewiki , or
• Asks in natural language to generate a wiki / documentation from a repository (e.g. "generate a wiki for anthropics/claude-code").

Trigger command

/codewiki 

Dependencies

This skill depends on CodeWiki (FSoft-AI4Code/CodeWiki). The codewiki CLI — provided by that project — must be installed and available on $PATH before the underlying script can run. The script's startup check_dependencies step will fail with exit code 2 and a clear message if codewiki is missing.

If the user has not installed CodeWiki yet, direct them to and have them follow the install instructions there before confirming execution.

When the user requests rendering (--render), two additional host tools are required: python3 (MkDocs) and node + npm (VitePress). The per-renderer dependencies are installed automatically into isolated sandboxes (Python venv / private node_modules) at render time, so the user never needs to run pip install or npm install manually. If either host tool is missing, render_docs.sh exits with a friendly install hint.

Agent execution logic

Follow these steps in order. Do not execute the underlying script until the user has explicitly confirmed.

1. Parse ``

Extract five fields from the user's input. Accept natural-language phrasing and shorthand.

Detection heuristics:

• repository: the first token matching ^\w[\w.-]*/[\w.-]+$, or starting with https:// or git@.
• output dir: a token following words like into, to, under, at, or a path-looking token (./, /, or containing /).
• instructions: everything remaining after repository and output are removed. Treat quoted strings as a single instruction block.
• render stack: triggered by keywords like render, mkdocs, vitepress, build site, static site. Map mkdocs / vitepress / both directly. The word "render" alone (without a named stack) should be clarified with the user before defaulting — do not silently pick a stack.
• serve: triggered by serve, preview, open in browser, live preview. If a port number appears nearby (e.g. "on 3000"), use it; otherwise omit the port and let render_docs.sh default to 8000. Serving implies --render is also set — if --serve is requested but no stack is named, ask the user which stack to render.

2. Present a structured confirmation overview

Render the parsed options back to the user in a compact block before doing anything. Example:

╭─ codewiki — parameters ──────────────────────────────╮
│ Repository   : anthropics/claude-code                │
│   (expanded) : https://github.com/anthropics/        │
│                claude-code.git                       │
│ Output dir   : .                                     │
│ Instructions : "Focus on the auth module; skip       │
│                vendored code."                       │
│ Render stack : both                                  │
│ Serve        : on, port 3000                         │
╰──────────────────────────────────────────────────────╯

If a field was inferred from natural language (not stated literally), mark it with (inferred) so the user can correct it. If Serve is on, always show the URLs that will be served (http://localhost:PORT for mkdocs, http://localhost:PORT+1 for vitepress when --render both) so the user knows what to expect.

3. Prompt for confirmation or modification (STRICT)

Present exactly two actionable paths. Do not run the script yet.

Confirm to execute, or tell me what to change.

• Reply yes / confirm / go → I will run:

  ./scripts/codewiki.sh -r anthropics/claude-code \
              -o . \
              -i "Focus on the auth module; skip vendored code." \
              --render both \
              --serve 3000
  

• Reply modify: = → I will update the parameter table and re-prompt.
• Reply cancel → abort without side effects.

4. Execute (only after confirmation)

Run the underlying script with the exact flags agreed above. Stream its output to the conversation. On completion, report:

• The path to the generated wiki (typically //wiki).
• The paths to any rendered static sites (//mkdocs/site, //vitepress/site).
• The preview URLs if --serve was used.
• Any warnings from codewiki or render_docs.sh worth the user's attention.

If --serve was used, the script blocks in the foreground serving HTTP. Tell the user explicitly to press Ctrl-C when done previewing — the cleanup trap will tear down the server(s) automatically.

Hard rules

• Never run codewiki.sh before the user confirms. This skill clones remote repositories — that is a side effect with network and disk cost. Rendering and serving add further disk and long-running process side effects.
• Never invent a repository when none was provided. If parsing yields no repository, ask the user for one.
• Never silently pick a render stack. If the user says "render" but does not name mkdocs / vitepress / both, ask which stack they want.
• Never start --serve without --render. The script will reject this with exit code 1, but call it out during parsing so the user is not surprised.
• Always show the expanded clone URL when the user supplied a shorthand group/repo form, so they can verify the target before cloning.
• Always show which ports will be opened when --serve is used.
• Preserve instruction text verbatim. Do not reword, summarize, or trim it before passing it to -i.