clast-ai 0.1.1 → 0.1.2

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.
Files changed (2) hide show
  1. package/README.md +40 -27
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -16,50 +16,63 @@ AST-based code intelligence plugin for Claude Code. Indexes your repository usin
16
16
 
17
17
  ## Quick Start
18
18
 
19
- ### Option 1: Install from npm (once published)
19
+ **Two steps:** install the package, then register it with Claude Code.
20
+
21
+ ### Step 1: Install
20
22
 
21
23
  ```bash
22
24
  npm install -g clast-ai
23
25
  ```
24
26
 
25
- ### Option 2: Install from GitHub (no cloning needed)
27
+ ### Step 2: Register with Claude Code
26
28
 
27
29
  ```bash
28
- npm install -g github:xls/clast
30
+ claude mcp add -s user clast clast-ai
29
31
  ```
30
32
 
31
- npm fetches the repo, installs dependencies, and builds automatically via the `prepare` script. The `clast` command will be available globally.
33
+ The `-s user` flag makes it available globally across all projects. Without it, the server is only registered for the current directory.
34
+
35
+ ### Step 3: Reload
36
+
37
+ - **VS Code:** Press `Ctrl+Shift+P` (or `Cmd+Shift+P` on Mac) → type "Developer: Reload Window" → Enter
38
+ - **CLI:** Just relaunch `claude`
39
+
40
+ ### Step 4: Verify
41
+
42
+ Type `/mcp` in the Claude Code chat panel. You should see `clast` listed with 7 tools.
43
+
44
+ > **That's it.** Clast will automatically index your project when Claude Code starts. No config files needed.
45
+
46
+ ---
47
+
48
+ ### Alternative Install Methods
32
49
 
33
- ### Option 3: Clone and Build
50
+ **From GitHub (no npm publish needed):**
34
51
 
35
52
  ```bash
36
- git clone https://github.com/xls/clast.git
37
- cd clast
38
- npm install
39
- npm run build
53
+ npm install -g github:xls/clast
54
+ claude mcp add -s user clast clast-ai
40
55
  ```
41
56
 
42
- ### Option 4: As a Claude Code Plugin
57
+ **Clone and build:**
43
58
 
44
59
  ```bash
45
60
  git clone https://github.com/xls/clast.git
46
61
  cd clast
47
62
  npm install && npm run build
48
- claude plugin add /path/to/clast
63
+ claude mcp add clast node /path/to/clast/dist/server/index.js
49
64
  ```
50
65
 
51
- The plugin bundles a model-invoked skill that automatically suggests Clast tools when Claude is exploring code.
52
-
53
- ### Publishing to npm
54
-
55
- If you want to publish your own fork:
66
+ **As a Claude Code Plugin** (includes auto-triggering skill):
56
67
 
57
68
  ```bash
58
- npm login
59
- npm publish
69
+ git clone https://github.com/xls/clast.git
70
+ cd clast
71
+ npm install && npm run build
72
+ claude plugin add /path/to/clast
60
73
  ```
61
74
 
62
- Then anyone can `npm install -g clast-ai`.
75
+ > The plugin install bundles a model-invoked skill that automatically tells Claude to prefer Clast tools over grep/file reading. With the MCP-only install, you may need to tell Claude to use the clast tools.
63
76
 
64
77
  ---
65
78
 
@@ -80,14 +93,14 @@ Add to `~/.claude/settings.local.json`:
80
93
  Or using the CLI:
81
94
 
82
95
  ```bash
83
- claude mcp add clast -- clast-ai
84
- # ^^^^^ ^^^^^^^^
85
- # alias command (npm package)
96
+ claude mcp add -s user clast clast-ai
97
+ # ^^^^^^^ ^^^^^ ^^^^^^^^
98
+ # global name command
86
99
  ```
87
100
 
88
- > `clast` is the local alias (shows up in `/mcp` and settings). `clast-ai` is the actual npm binary that gets executed. The alias can be anything you want.
101
+ > `-s user` makes it global (available in all projects). `clast` is the server name. `clast-ai` is the npm binary.
89
102
 
90
- Restart Claude Code (`Ctrl+Shift+P` → "Claude Code: Restart" in VS Code, or just relaunch the CLI). Clast will automatically index whichever project directory you open.
103
+ Reload VS Code (`Ctrl+Shift+P` → "Developer: Reload Window") or relaunch the CLI. Clast will automatically index whichever project directory you open.
91
104
 
92
105
  ## Setup for VS Code (Claude Code Extension)
93
106
 
@@ -96,7 +109,7 @@ The Claude Code extension for VS Code uses the **same MCP configuration files**
96
109
  **Step 1:** Open VS Code's integrated terminal and run:
97
110
 
98
111
  ```bash
99
- claude mcp add clast -- clast-ai
112
+ claude mcp add -s user clast clast-ai
100
113
  ```
101
114
 
102
115
  Or manually add to `~/.claude/settings.local.json`:
@@ -111,10 +124,10 @@ Or manually add to `~/.claude/settings.local.json`:
111
124
  }
112
125
  ```
113
126
 
114
- **Step 2:** Restart the Claude Code extension (no need to restart VS Code itself):
127
+ **Step 2:** Reload VS Code:
115
128
 
116
129
  - Press `Ctrl+Shift+P` (or `Cmd+Shift+P` on Mac)
117
- - Type "Claude Code: Restart" and hit Enter
130
+ - Type "Developer: Reload Window" and hit Enter
118
131
 
119
132
  **Step 3:** Verify by typing `/mcp` in the Claude Code chat panel — you should see `clast` listed with 7 tools.
120
133
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "clast-ai",
3
- "version": "0.1.1",
3
+ "version": "0.1.2",
4
4
  "description": "AST-based code intelligence plugin for Claude Code: search symbols, trace call graphs, generate comments, and provide structured context for any repository",
5
5
  "main": "dist/server/index.js",
6
6
  "bin": {