@chappibunny/repolens 1.14.1 → 1.14.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +28 -0
- package/README.md +26 -6
- package/llms-install.md +13 -0
- package/package.json +18 -4
- package/src/docs/branding.js +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,34 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to RepoLens will be documented in this file.
|
|
4
4
|
|
|
5
|
+
## 1.14.3
|
|
6
|
+
|
|
7
|
+
### Docs
|
|
8
|
+
|
|
9
|
+
- README "Use with Cline" section and `llms-install.md` for agent-driven installs
|
|
10
|
+
- Note on `min-release-age` / stale npx cache resolving a pre-MCP release
|
|
11
|
+
- Verified end to end from a clean npm cache with the MCP SDK stdio client: initialize, tools/list, all six tools on expressjs/express, error cases, stdout carries only JSON-RPC
|
|
12
|
+
|
|
13
|
+
## 1.14.2
|
|
14
|
+
|
|
15
|
+
### Discoverability
|
|
16
|
+
|
|
17
|
+
- Docs badge line now links to the gallery (`[Examples](https://chapibunny.github.io/repolens/)`)
|
|
18
|
+
- Added `glama.json` (Glama MCP directory ownership) and `CITATION.cff`
|
|
19
|
+
- More npm keywords; npm `homepage` points at the gallery
|
|
20
|
+
- README: MCP Registry and Gallery badges and a links row
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
### Gallery
|
|
24
|
+
|
|
25
|
+
Static showcase of deterministic RepoLens output for public repositories. The package version is unchanged.
|
|
26
|
+
|
|
27
|
+
- `gallery/build.mjs` shallow-clones the curated list in `gallery/repos.json`, runs RepoLens with AI disabled, and writes one HTML page per repository plus an index, `sitemap.xml`, and `robots.txt`
|
|
28
|
+
- A repository that fails to clone, fails the license check, or fails the scan is skipped. The build refuses to publish when too few repositories succeed
|
|
29
|
+
- `.github/workflows/gallery.yml` rebuilds the site weekly and on manual dispatch, caches clones, and deploys with GitHub Pages to `https://chapibunny.github.io/repolens/`
|
|
30
|
+
- `gallery/` stays out of the npm package: it is not in the `files` allowlist, and `/gallery` is listed in `.npmignore`
|
|
31
|
+
- Gallery pages use a flat Material layout: square corners, no shadows or gradients, one primary colour and one accent on white and light grey, a flat RepoLens app bar, and a dense repository table on the index. The same stylesheet covers each repository page
|
|
32
|
+
|
|
5
33
|
## 1.14.1
|
|
6
34
|
|
|
7
35
|
### Registry name and publish skip
|
package/README.md
CHANGED
|
@@ -12,9 +12,13 @@
|
|
|
12
12
|
[](https://marketplace.visualstudio.com/items?itemName=repolensdox.repolensdox)
|
|
13
13
|
[](https://github.com/CHAPIBUNNY/repolens/actions/workflows/test.yml)
|
|
14
14
|
[](LICENSE)
|
|
15
|
+
[](https://registry.modelcontextprotocol.io/v0/servers?search=io.github.CHAPIBUNNY/repolens)
|
|
16
|
+
[](https://chapibunny.github.io/repolens/)
|
|
15
17
|
[](https://cursor.com/install-mcp?name=repolens&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBjaGFwcGlidW5ueS9yZXBvbGVucyIsIm1jcCJdfQ%3D%3D)
|
|
16
18
|
[](https://insiders.vscode.dev/redirect/mcp/install?name=repolens&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40chappibunny%2Frepolens%22%2C%22mcp%22%5D%7D)
|
|
17
19
|
|
|
20
|
+
**Links:** [Gallery](https://chapibunny.github.io/repolens/) · [npm](https://www.npmjs.com/package/@chappibunny/repolens) · [MCP Registry](https://registry.modelcontextprotocol.io/v0/servers?search=io.github.CHAPIBUNNY/repolens) · [VS Code extension](https://marketplace.visualstudio.com/items?itemName=repolensdox.repolensdox) · [GitHub Action](action.yml)
|
|
21
|
+
|
|
18
22
|
**Your architecture docs are already outdated.** RepoLens fixes that.
|
|
19
23
|
|
|
20
24
|
RepoLens scans your repository, generates living architecture documentation, and publishes it to Notion, Confluence, GitHub Wiki, Obsidian, or Markdown — automatically on every push. Engineers get technical docs. Stakeholders get readable system overviews. Nobody writes a word.
|
|
@@ -27,6 +31,8 @@ RepoLens scans your repository, generates living architecture documentation, and
|
|
|
27
31
|
|
|
28
32
|
> **Try it now** — no installation required. Run `npx @chappibunny/repolens demo` on any repo for an instant local preview.
|
|
29
33
|
|
|
34
|
+
**[See it on real repos](https://chapibunny.github.io/repolens/)** — architecture pages RepoLens generated for Express, FastAPI, Django, Gin, mdBook, and other public projects. Deterministic mode, no API keys.
|
|
35
|
+
|
|
30
36
|
🎬 **[Watch Demo Video](https://www.loom.com/share/8e077624e69f41319fd93acbbe03871e)** — See RepoLens generate docs in 60 seconds
|
|
31
37
|
|
|
32
38
|
<table>
|
|
@@ -186,7 +192,7 @@ Step-by-step setup for publishers, AI features, Notion, Confluence, GitHub Wiki,
|
|
|
186
192
|
|
|
187
193
|
## MCP server
|
|
188
194
|
|
|
189
|
-
Cursor, Claude Desktop, Claude Code, and VS Code Copilot can call RepoLens over stdio. The server is read-only except for `generate_docs`, which writes Markdown inside the workspace. Deterministic mode does not use the network. Paths cannot leave the workspace root.
|
|
195
|
+
Cursor, Cline, Claude Desktop, Claude Code, and VS Code Copilot can call RepoLens over stdio. The server is read-only except for `generate_docs`, which writes Markdown inside the workspace. Deterministic mode does not use the network. Paths cannot leave the workspace root.
|
|
190
196
|
|
|
191
197
|
[](https://cursor.com/install-mcp?name=repolens&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBjaGFwcGlidW5ueS9yZXBvbGVucyIsIm1jcCJdfQ%3D%3D)
|
|
192
198
|
[](https://insiders.vscode.dev/redirect/mcp/install?name=repolens&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40chappibunny%2Frepolens%22%2C%22mcp%22%5D%7D)
|
|
@@ -204,9 +210,21 @@ Copy-paste configs for Cursor, Claude Desktop, and VS Code are in [docs/MCP.md](
|
|
|
204
210
|
}
|
|
205
211
|
```
|
|
206
212
|
|
|
213
|
+
### Use with Cline
|
|
214
|
+
|
|
215
|
+
Open Cline → MCP Servers → Installed → Configure MCP Servers, paste this into `cline_mcp_settings.json`, and save:
|
|
216
|
+
|
|
217
|
+
```json
|
|
218
|
+
{"mcpServers":{"repolens":{"command":"npx","args":["-y","@chappibunny/repolens","mcp"]}}}
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
Cline starts the server with no install step (Node 18+ required). It reads the directory the server starts in. To point it at a specific repo, add `"env": {"REPOLENS_WORKSPACE": "/absolute/path/to/repo"}`. Six tools appear: `get_system_overview`, `list_modules`, `get_api_surface`, `get_dependency_graph`, `get_architecture_diff`, `generate_docs`. Step-by-step agent instructions are in [llms-install.md](llms-install.md).
|
|
222
|
+
|
|
223
|
+
If `npx` reports `Unknown command: mcp`, an `.npmrc` with `min-release-age` (or an old npx cache) resolved a release older than 1.14.0. Use `npx -y @chappibunny/repolens@latest mcp` or clear `~/.npm/_npx`.
|
|
224
|
+
|
|
207
225
|
## GitHub Action
|
|
208
226
|
|
|
209
|
-
`action.yml` is a composite action named **RepoLens Architecture Docs**. It runs the published npm package (`npx --yes @chappibunny/repolens@1.14.
|
|
227
|
+
`action.yml` is a composite action named **RepoLens Architecture Docs**. It runs the published npm package (`npx --yes @chappibunny/repolens@1.14.3`). Inputs are `command` (`publish`, `demo`, or `doctor`), `config`, `node-version`, `pr-comment`, and `version`.
|
|
210
228
|
|
|
211
229
|
```yaml
|
|
212
230
|
name: Architecture docs
|
|
@@ -222,7 +240,7 @@ jobs:
|
|
|
222
240
|
runs-on: ubuntu-latest
|
|
223
241
|
steps:
|
|
224
242
|
- uses: actions/checkout@9f698171ed81b15d1823a05fc7211befd50c8ae0 # v6.0.3
|
|
225
|
-
- uses: CHAPIBUNNY/repolens@v1.14.
|
|
243
|
+
- uses: CHAPIBUNNY/repolens@v1.14.3
|
|
226
244
|
with:
|
|
227
245
|
command: publish
|
|
228
246
|
config: .repolens.yml
|
|
@@ -230,16 +248,18 @@ jobs:
|
|
|
230
248
|
pr-comment: ${{ github.event_name == 'pull_request' && 'true' || 'false' }}
|
|
231
249
|
```
|
|
232
250
|
|
|
233
|
-
The action is listed on the GitHub Marketplace only after a release is published with **Publish this Action to the GitHub Marketplace** checked. Those steps are in [docs/RELEASE.md](docs/RELEASE.md). The tag `v1.14.1` has to exist before `uses: CHAPIBUNNY/repolens@v1.14.
|
|
251
|
+
The action is listed on the GitHub Marketplace only after a release is published with **Publish this Action to the GitHub Marketplace** checked. Those steps are in [docs/RELEASE.md](docs/RELEASE.md). The tag `v1.14.1` has to exist before `uses: CHAPIBUNNY/repolens@v1.14.3` resolves, and `@chappibunny/repolens@1.14.3` has to be on npm before the action can install it.
|
|
234
252
|
|
|
235
253
|
## Add the badge to your repo
|
|
236
254
|
|
|
237
255
|
Generated Markdown includes this line unless `.repolens.yml` sets `branding: false` (or `branding.badge: false`). Add the same badge to a repository README:
|
|
238
256
|
|
|
239
257
|
```markdown
|
|
240
|
-
[](https://github.com/CHAPIBUNNY/repolens)
|
|
258
|
+
[](https://github.com/CHAPIBUNNY/repolens) · [Examples](https://chapibunny.github.io/repolens/)
|
|
241
259
|
```
|
|
242
260
|
|
|
261
|
+
Generated docs also link to the [gallery](https://chapibunny.github.io/repolens/) after the badge.
|
|
262
|
+
|
|
243
263
|
---
|
|
244
264
|
|
|
245
265
|
## 📸 Example Output
|
|
@@ -248,7 +268,7 @@ Generated Markdown includes this line unless `.repolens.yml` sets `branding: fal
|
|
|
248
268
|
|
|
249
269
|
Published system maps are Unicode diagrams drawn from import edges. RepoLens does not emit Mermaid.
|
|
250
270
|
|
|
251
|
-
The publisher set is Notion, Confluence, GitHub Wiki, Obsidian, and Markdown (`src/publishers`, 7 files). 1.14.0 adds the MCP server, the Marketplace action, and the docs badge. 1.14.1 sets the registry name to `io.github.CHAPIBUNNY/repolens`. Layout and counts are in [ARCHITECTURE.md](docs/ARCHITECTURE.md).
|
|
271
|
+
The publisher set is Notion, Confluence, GitHub Wiki, Obsidian, and Markdown (`src/publishers`, 7 files). 1.14.0 adds the MCP server, the Marketplace action, and the docs badge. 1.14.1 sets the registry name to `io.github.CHAPIBUNNY/repolens`. 1.14.2 adds the gallery link to the badge line, `glama.json`, and `CITATION.cff`. 1.14.3 adds Cline setup docs and `llms-install.md`. Layout and counts are in [ARCHITECTURE.md](docs/ARCHITECTURE.md).
|
|
252
272
|
|
|
253
273
|
### System Overview (Technical Profile)
|
|
254
274
|
|
package/llms-install.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Installing the RepoLens MCP server (for AI agents)
|
|
2
|
+
|
|
3
|
+
1. Requires Node.js 18 or newer. Nothing else needs to be installed; `npx` fetches the package.
|
|
4
|
+
2. Add this to the MCP settings file (Cline: `cline_mcp_settings.json`):
|
|
5
|
+
|
|
6
|
+
```json
|
|
7
|
+
{"mcpServers":{"repolens":{"command":"npx","args":["-y","@chappibunny/repolens","mcp"]}}}
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
3. Optional: set `"env": {"REPOLENS_WORKSPACE": "/absolute/path/to/repo"}` to choose the repository. Otherwise the server reads its working directory.
|
|
11
|
+
4. No API keys are needed. Tools run deterministically and offline unless `generate_docs` is called with `deterministic: false`.
|
|
12
|
+
5. Verify: the server should list six tools — `get_system_overview`, `list_modules`, `get_api_surface`, `get_dependency_graph`, `get_architecture_diff`, `generate_docs`. Call `get_system_overview` with no arguments.
|
|
13
|
+
6. If you see `Unknown command: mcp`, an older release was resolved (often an `.npmrc` with `min-release-age`). Use `@chappibunny/repolens@latest`.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@chappibunny/repolens",
|
|
3
|
-
"version": "1.14.
|
|
3
|
+
"version": "1.14.3",
|
|
4
4
|
"mcpName": "io.github.CHAPIBUNNY/repolens",
|
|
5
5
|
"description": "AI-assisted documentation intelligence system for technical and non-technical audiences",
|
|
6
6
|
"license": "MIT",
|
|
@@ -22,7 +22,8 @@
|
|
|
22
22
|
"src",
|
|
23
23
|
"package.json",
|
|
24
24
|
"README.md",
|
|
25
|
-
"CHANGELOG.md"
|
|
25
|
+
"CHANGELOG.md",
|
|
26
|
+
"llms-install.md"
|
|
26
27
|
],
|
|
27
28
|
"keywords": [
|
|
28
29
|
"cli",
|
|
@@ -41,13 +42,26 @@
|
|
|
41
42
|
"obsidian",
|
|
42
43
|
"ai-documentation",
|
|
43
44
|
"mcp",
|
|
44
|
-
"model-context-protocol"
|
|
45
|
+
"model-context-protocol",
|
|
46
|
+
"architecture-documentation",
|
|
47
|
+
"documentation-generator",
|
|
48
|
+
"docs-as-code",
|
|
49
|
+
"living-documentation",
|
|
50
|
+
"dependency-graph",
|
|
51
|
+
"codebase-analysis",
|
|
52
|
+
"static-analysis",
|
|
53
|
+
"mcp-server",
|
|
54
|
+
"github-action",
|
|
55
|
+
"vscode",
|
|
56
|
+
"code-documentation",
|
|
57
|
+
"software-architecture",
|
|
58
|
+
"ai"
|
|
45
59
|
],
|
|
46
60
|
"repository": {
|
|
47
61
|
"type": "git",
|
|
48
62
|
"url": "git+https://github.com/CHAPIBUNNY/repolens.git"
|
|
49
63
|
},
|
|
50
|
-
"homepage": "https://github.
|
|
64
|
+
"homepage": "https://chapibunny.github.io/repolens/",
|
|
51
65
|
"bugs": {
|
|
52
66
|
"url": "https://github.com/CHAPIBUNNY/repolens/issues"
|
|
53
67
|
},
|
package/src/docs/branding.js
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
export const DOCS_BADGE_MARKER = "<!-- repolens:docs-badge -->";
|
|
7
7
|
|
|
8
8
|
export const DOCS_BADGE_MARKDOWN =
|
|
9
|
-
"[](https://github.com/CHAPIBUNNY/repolens)";
|
|
9
|
+
"[](https://github.com/CHAPIBUNNY/repolens) · [Examples](https://chapibunny.github.io/repolens/)";
|
|
10
10
|
|
|
11
11
|
export function brandingEnabled(config) {
|
|
12
12
|
const branding = config?.branding;
|