You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-**35 MCP tools**: parse, search, impact analysis, flow tracing, dead code detection, postprocess operations, namespace file management, and more
15
15
-**RAG-first code exploration**: generated docs + community structure let LLM agents answer natural-language questions before drilling into exact graph nodes
16
+
-**Browser Wiki UI**: `ccg-server` can serve generated docs, tree search, PageIndex-style retrieval, Context Tray copying, and an Obsidian-style graph viewer
16
17
-**Custom annotations**: `@intent`, `@domainRule`, `@sideEffect`, `@mutates`, `@index` — search code by business context ([details](guide/annotations.md))
17
18
-**Webhook sync**: GitHub / Gitea push events → auto clone + build with per-repo branch filtering and `.ccg.yaml``include_paths` auto-loading ([details](guide/webhook.md))
18
19
-**Eval**: Golden corpus-based parser accuracy (P/R/F1) and search quality (P@K, MRR, nDCG) evaluation ([details](guide/eval.md))
@@ -68,6 +69,9 @@ ccg search "payment" # finds functions with @intent/@domainRule about payment
68
69
# Build docs and the default vectorless RAG index for agent-oriented exploration
69
70
ccg docs --out docs
70
71
72
+
# Serve the browser Wiki UI from built assets
73
+
make wiki-run
74
+
71
75
# Graph statistics
72
76
ccg status
73
77
@@ -85,10 +89,12 @@ ccg eval --suite parser
85
89
ccg eval --suite parser --update
86
90
```
87
91
88
-
`ccg docs` refreshes community structure and writes `.ccg/doc-index.json` by
89
-
default. Use `--rag=false` when you only want Markdown, or
90
-
`--rag-refresh=false` when you want to rebuild the index from existing community
91
-
rows without recalculating communities.
92
+
`ccg docs` writes generated Markdown plus `.ccg/wiki-index.json` for the browser
93
+
Wiki. By default it also refreshes community structure and writes
94
+
`.ccg/doc-index.json` for vectorless RAG retrieval. Use `--rag=false` when you
95
+
only want Markdown and the Wiki index, or `--rag-refresh=false` when you want to
96
+
rebuild the RAG index from existing community rows without recalculating
97
+
communities.
92
98
93
99
For LLM agents, treat generated docs and the RAG index as the primary entrypoint
94
100
for natural-language questions such as "how does webhook sync work?" or "where
@@ -103,6 +109,37 @@ also applies when upgrading CCG against an existing default `ccg.db` created by
103
109
an older version. See the [CLI Reference](guide/cli-reference.md) for the full
104
110
migration contract.
105
111
112
+
## Browser Wiki
113
+
114
+
`ccg-server` can serve a React-based Wiki UI at `/wiki` when `--wiki-dir` points
115
+
at a built `web/wiki/dist` directory. Docker images include that built UI at
116
+
`/usr/share/ccg/wiki`; standalone binaries keep the assets separate so binary
117
+
size stays small.
118
+
119
+
The Wiki is meant for developers and agents inspecting a generated codebase:
120
+
121
+
- Tree navigation over folders, packages, files, and annotated symbols
122
+
- Keyword search and PageIndex-style `retrieve_docs` over `doc-index.json`
123
+
- Rich symbol detail cards from CCG annotations even when a symbol has no
124
+
generated Markdown file
125
+
- Context Tray for collecting files and doc-less symbols into one Markdown
126
+
bundle that can be copied into another LLM tool
127
+
- Graph tab backed by `/wiki/api/graph`, showing namespace nodes and edges with
128
+
filters for structure, calls, imports, types, and symbols
129
+
130
+
Local development shortcut:
131
+
132
+
```bash
133
+
ccg build .
134
+
ccg docs --out docs
135
+
make wiki-run
136
+
```
137
+
138
+
For self-hosted deployments, run `ccg-server --wiki-dir <dist-dir>` and protect
139
+
`/wiki/api/*` with the same bearer token policy used for `/mcp`. See
140
+
[Docker](guide/docker.md#wiki-ui) and [Runtime Layout](guide/runtime-layout.md)
141
+
for deployment details.
142
+
106
143
## Demo
107
144
108
145
Actual output from CCG parsing its own codebase.
@@ -201,7 +238,8 @@ Add `.mcp.json` to your project:
201
238
202
239
For remote HTTP mode:
203
240
204
-
Run the self-hosted server with `ccg-server` and connect to `/mcp`:
241
+
Run the self-hosted server with `ccg-server` and connect to `/mcp`. The same
242
+
server can also expose `/wiki` when `--wiki-dir` is configured:
|[Postprocess Failure Policy](guide/postprocess-failure-policy.md)| Status rules, failure causes, and automatic degraded/fail_closed policy for build and postprocess tools |
252
-
|[Runtime Layout](guide/runtime-layout.md)|`ccg`, `ccg-server`, and shared `ccg-core` ownership boundaries |
290
+
|[Runtime Layout](guide/runtime-layout.md)|`ccg`, `ccg-server`, Wiki serving, and shared `ccg-core` ownership boundaries |
253
291
|[Development](guide/development.md)| Dev guide, integration test, project structure |
254
292
|[Namespace Migration](guide/namespace-migration.md)| Default namespace change and migration guide |
255
293
|[Architecture](guide/architecture.md)| Data flow, components, DB schema |
0 commit comments