Open Wiki

1# open-wiki
2 
3**The open-source alternative to Google's Code Wiki — with MCP.**
4 
5Index any codebase with tree-sitter, generate docs with your LLM, serve them through a full-featured docs site, and expose everything as tools for coding agents via MCP. Like Notion for code agents.
6 
7```
8ow /path/to/your/project
9```
10 
11---
12 
13## Install
14 
15```bash
16npm install -g open-wiki
17```
18 
19---
20 
21## Quick Start
22 
23```bash
24# 1. Set your API key
25ow config set-key anthropic sk-ant-...
26 
27# 2. Index a project
28ow /path/to/project
29 
30# 3. Open the docs
31ow serve
32# → http://localhost:8383
33```
34 
35---
36 
37## Commands
38 
39### `ow [path]`
40 
41Index a project and generate documentation. Defaults to the current directory.
42 
43```bash
44ow                            # index current directory
45ow /path/to/project           # index a specific path
46ow . --force                  # re-index all files (ignore cache)
47ow . --name myapp             # override the project name
48ow . --provider openai        # use a specific LLM provider
49```
50 
51| Flag | Description |
52|------|-------------|
53| `-p, --provider <name>` | LLM provider: `anthropic`, `openai`, `google` |
54| `--name <name>` | Override project name (defaults to directory name) |
55| `--force` | Re-index all files regardless of changes |
56 
57---
58 
59### `ow serve`
60 
61Start the docs server.
62 
63```bash
64ow serve                      # start on default port 8383
65ow serve --port 3000          # custom port
66```
67 
68| Flag | Description |
69|------|-------------|
70| `-p, --port <port>` | Port to listen on (default: `8383`) |
71 
72---
73 
74### `ow config`
75 
76Manage API keys and provider settings.
77 
78```bash
79ow config set-key anthropic sk-ant-...     # set Anthropic key
80ow config set-key openai sk-...            # set OpenAI key
81ow config set-key google AIza...           # set Google key
82ow config set-default openai              # change default provider
83ow config list                            # show all configured providers
84```
85 
86Supported providers: `anthropic`, `openai`, `google`
87 
88---
89 
90### `ow list`
91 
92List all indexed projects.
93 
94```bash
95ow list
96```
97 
98---
99 
100### `ow mcp`
101 
102MCP server for coding agents. Exposes your indexed docs as tools.
103 
104```bash
105ow mcp install    # register with Claude Code (run once)
106ow mcp            # start the stdio MCP server (Claude Code does this automatically)
107```
108 
109After `ow mcp install`, Claude Code gets 5 tools:
110 
111| Tool | What it does |
112|------|-------------|
113| `list_projects` | List all indexed projects with file and symbol counts |
114| `get_project_overview` | Get the architecture overview and mermaid diagram for a project |
115| `get_file_doc` | Get documentation for a specific file |
116| `search_docs` | Full-text search across all docs in a project |
117| `get_symbols` | List all functions, classes, and interfaces in a file or project |
118 
119---
120 
121### `ow setup`
122 
123Manage the underlying docs app.
124 
125```bash
126ow setup            # install the docs app (runs automatically on first use)
127ow setup --reset    # wipe and reinstall from scratch
128```
129 
130---
131 
132## How It Works
133 
1341. **Index** — tree-sitter parses your source files and extracts symbols, signatures, and imports
1352. **Generate** — one structured LLM call per file produces a summary and per-symbol docs
1363. **Diff** — only changed files are re-processed on subsequent runs
1374. **Serve** — a Next.js + fumadocs app renders the generated MDX with syntax highlighting, mermaid diagrams, and AI chat
1385. **MCP** — the stdio server reads directly from the SQLite index and MDX files
139 
140---
141 
142## Supported Languages
143 
144- TypeScript / JavaScript (`.ts`, `.tsx`, `.js`, `.jsx`)
145- Python (`.py`)
146 
147---
148 
149## License
150 
151MIT
152