dsh-codebase-chat 0.16.0 → 0.16.2

package/README.md

@@ -1,26 +1,37 @@
-# dsh-codebase-chat
+<p align="center">
+  <img src="https://raw.githubusercontent.com/shinzarou-eng/dsh-codebase-chat/main/docs/assets/logo.svg" width="120" height="120" alt="dsh-codebase-chat logo">
+</p>
+
+<h1 align="center">dsh-codebase-chat</h1>
 
-[![Release](https://img.shields.io/github/v/release/shinzarou-eng/dsh-codebase-chat?logo=github)](https://github.com/shinzarou-eng/dsh-codebase-chat/releases)
-[![License](https://img.shields.io/github/license/shinzarou-eng/dsh-codebase-chat?color=blue)](./LICENSE)
-[![Node](https://img.shields.io/badge/node-%3E%3D20-brightgreen?logo=nodedotjs)](https://nodejs.org)
-[![MCP](https://img.shields.io/badge/MCP-Compatible-purple)](https://modelcontextprotocol.io)
+<p align="center">
+  <strong>Multi-language codebase intelligence for DeepSeek Harness and any MCP IDE.</strong><br>
+  Chat, search, explain, refactor, audit, and generate board-ready reports from local code.
+</p>
 
-> A powerful, multi-language codebase intelligence engine for **DeepSeek Harness** and any **MCP-compatible** IDE (Windsurf, Cursor, Claude, etc.).
-> Chat, search, explain, refactor, audit, and generate board-ready reports from a local codebase — without leaking data to third-party services.
+<p align="center">
+  <a href="https://www.npmjs.com/package/dsh-codebase-chat"><img src="https://img.shields.io/npm/v/dsh-codebase-chat?logo=npm&color=blue" alt="npm"></a>
+  <a href="https://www.npmjs.com/package/dsh-codebase-chat-mcp"><img src="https://img.shields.io/npm/v/dsh-codebase-chat-mcp?logo=npm&color=purple" alt="npm mcp"></a>
+  <a href="https://github.com/shinzarou-eng/dsh-codebase-chat/releases"><img src="https://img.shields.io/github/v/release/shinzarou-eng/dsh-codebase-chat?logo=github" alt="release"></a>
+  <a href="./LICENSE"><img src="https://img.shields.io/github/license/shinzarou-eng/dsh-codebase-chat?color=blue" alt="license"></a>
+  <a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-%3E%3D20-brightgreen?logo=nodedotjs" alt="node"></a>
+  <a href="https://modelcontextprotocol.io"><img src="https://img.shields.io/badge/MCP-Compatible-purple" alt="mcp"></a>
+</p>
 
 <p align="center">
+  <a href="https://shinzarou-eng.github.io/dsh-codebase-chat">Website</a> ·
   <a href="https://github.com/shinzarou-eng/dsh-codebase-chat/releases">Releases</a> ·
   <a href="#install">Install</a> ·
-  <a href="#mcp-server">MCP</a> ·
+  <a href="#mcp">MCP</a> ·
   <a href="#commands">Commands</a> ·
-  <a href="#github-pages-docs">Docs</a>
+  <a href="#faq">FAQ</a>
 </p>
 
 ---
 
 ## Why dsh-codebase-chat?
 
-Most codebase assistants are slow, paywalled, or force you to upload source code to the cloud. **dsh-codebase-chat** runs locally, reads only the files you point at, and turns raw code into structured intelligence:
+Most codebase assistants are **slow, paywalled, or force you to upload source code to the cloud**. **dsh-codebase-chat** runs **locally**, reads only the files you point at, and turns raw code into structured intelligence — with **source citations, confidence scores, and severity labels**.
 
 | Capability | What it gives you |
 | --- | --- |
@@ -35,8 +46,6 @@ Most codebase assistants are slow, paywalled, or force you to upload source code
 | **Player Brief** | UX / playthrough analysis from a real user perspective. |
 | **Crea** | Slogans, taglines, and feature ideas inspired by the code. |
 
-Every output is **grounded in real source files** with file and line citations. No guesswork, no cloud, no data leakage.
-
 ---
 
 ## Quick start
@@ -44,10 +53,9 @@ Every output is **grounded in real source files** with file and line citations.
 ### 1. DeepSeek Harness plugin
 
 ```powershell
-# Install in any profile
-pnpm add "file:C:/path/to/dsh-codebase-chat"
+pnpm add dsh-codebase-chat
 # or
-npm install "file:C:/path/to/dsh-codebase-chat"
+npm install dsh-codebase-chat
 ```
 
 Then open `http://127.0.0.1:3080` and click the **Codebase Pro** button in the sidebar.
@@ -94,13 +102,13 @@ pnpm install
 ## Commands
 
 ```powershell
-# Ask a question (auto-detect project from current directory)
+# Ask a question
 dsh --profile headless '/codebase "how is auth handled?"'
 
 # Ask with explicit project
 dsh --profile headless '/codebase "how is auth handled?" --project C:\my-app'
 
-# Append a creative idea at the end
+# Append a creative idea
 dsh --profile headless '/codebase "how does storage work?" --project C:\my-app --crea --crea-theme "slogan"'
 
 # Search, explain, refactor
@@ -127,7 +135,7 @@ dsh --profile headless '/codebase-git --project C:\my-app'
 
 ---
 
-## Architecture
+## How it works
 
 ```mermaid
 graph LR
@@ -140,53 +148,21 @@ graph LR
   G --> H[Structured response with citations]
 ```
 
-1. **Context collector** reads package.json, source files, tests, config, git, build output.
+1. **Context collector** reads `package.json`, source files, tests, config, git, build output.
 2. **Module graph** maps who calls who.
-3. **Debt scanner** flags TODO/FIXME/HACK/console.log/any/etc.
+3. **Debt scanner** flags `TODO` / `FIXME` / `HACK` / `console.log` / `any` / `debugger`.
 4. **Prompt builder** assembles a language-aware, evidence-based prompt.
 5. **LLM** returns a response that includes source citations, confidence scores, and severity badges.
 
 ---
 
-## Web UI
-
-When installed in the **web** profile, the plugin adds a **Codebase Pro** button in the sidebar footer:
-
-<p align="center">
-  <img src="https://raw.githubusercontent.com/shinzarou-eng/dsh-codebase-chat/main/docs/assets/codebase-pro-button.svg" alt="Codebase Pro button" width="240">
-</p>
-
-One click opens the brief selector and launches the chosen mode in the user's language.
-
----
-
-## Tools exposed
-
-- `codebase_chat`
-- `codebase_search`
-- `codebase_explain`
-- `codebase_refactor`
-- `codebase_crea`
-- `codebase_intelligence`
-- `codebase_audit`
-- `codebase_report`
-- `codebase_tasks`
-- `codebase_apply_tasks`
-- `codebase_ceo`
-- `codebase_build`
-- `codebase_git`
-- `codebase_apply`
-- `codebase_player`
-
----
-
 ## Evidence & scoring
 
-Every professional brief now requires the model to:
+Every technical claim, risk, and opportunity is marked with:
 
-- Cite sources as `[source: relative/path/file.ts:line]`
-- Mark recommendations with `[Confidence: X%]`
-- Mark risks and issues with `[Severity: Critical/High/Medium/Low]`
+- `[source: relative/path/file.ts:line]`
+- `[Confidence: X%]`
+- `[Severity: Critical/High/Medium/Low]`
 
 No fabricated citations, no hand-waving.
 
@@ -194,7 +170,7 @@ No fabricated citations, no hand-waving.
 
 ## Multi-language
 
-The plugin detects the user's language and generates the entire prompt in that language. Supported locales:
+The plugin detects the user's language and generates the entire prompt in that language.
 
 - `fr` — French
 - `en` — English
@@ -203,13 +179,43 @@ More languages can be added by extending the `build*Prompt` functions.
 
 ---
 
+## Web UI
+
+When installed in the **web** profile, the plugin adds a **Codebase Pro** button in the sidebar footer:
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/shinzarou-eng/dsh-codebase-chat/main/docs/assets/codebase-pro-button.svg" alt="Codebase Pro button" width="240">
+</p>
+
+One click opens the brief selector and launches the chosen mode in the user's language.
+
+---
+
 ## Install as a DSH plugin
 
 ```powershell
-dsh plugin --profile headless add "file:C:/Users/YOU/dsh-codebase-chat"
-dsh plugin --profile web add "file:C:/Users/YOU/dsh-codebase-chat"
+dsh plugin --profile headless add dsh-codebase-chat
+dsh plugin --profile web add dsh-codebase-chat
 ```
 
+For a local development build, use the `file:` path to your clone.
+
+---
+
+## FAQ
+
+**Does it send my code to the cloud?**  
+No. All context collection and prompt building run on your machine. Only the final prompt is sent to the LLM you configure.
+
+**Can I use it with Claude, Cursor, or Windsurf?**  
+Yes. Install `dsh-codebase-chat-mcp` and add it to your MCP server config.
+
+**Does it work without DeepSeek Harness?**  
+Yes. The `dsh-codebase-chat-mcp` package is fully standalone.
+
+**Which languages are supported?**  
+French and English out of the box. The prompt builders are designed to be extended.
+
 ---
 
 ## Troubleshooting
@@ -244,6 +250,12 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
 
 ---
 
+## Support
+
+Open an issue on [GitHub](https://github.com/shinzarou-eng/dsh-codebase-chat/issues).
+
+---
+
 ## License
 
-[MIT](./LICENSE) — Built and maintained by [shinzarou-eng](https://github.com/shinzarou-eng).
+[MIT](https://github.com/shinzarou-eng/dsh-codebase-chat/blob/main/LICENSE) — Built and maintained by [shinzarou-eng](https://github.com/shinzarou-eng).

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "dsh-codebase-chat",
-  "version": "0.16.0",
+  "version": "0.16.2",
   "description": "Multi-language codebase intelligence for DeepSeek Harness and MCP-compatible IDEs: chat, search, audit, refactor, and board-ready reports from local code.",
   "homepage": "https://shinzarou-eng.github.io/dsh-codebase-chat",
   "repository": {
     "type": "git",
-    "url": "https://github.com/shinzarou-eng/dsh-codebase-chat.git"
+    "url": "git+https://github.com/shinzarou-eng/dsh-codebase-chat.git"
   },
   "bugs": {
     "url": "https://github.com/shinzarou-eng/dsh-codebase-chat/issues"