@twahaa/codefinder 1.0.0 → 1.0.1

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 +30 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -175,6 +175,36 @@ You will be prompted for:
175
175
 
176
176
  ---
177
177
 
178
+ ## Installation and Usage
179
+
180
+ The `codefinder` package provides a command-line interface (CLI) tool for exploring and searching codebases.
181
+
182
+ ### Installation
183
+
184
+ To install `codefinder` globally, run:
185
+
186
+ ```bash
187
+ npm install -g @twahaa/codefinder
188
+ ```
189
+
190
+ Alternatively, you can use `npx` to run it without global installation:
191
+
192
+ ```bash
193
+ npx @twahaa/codefinder
194
+ ```
195
+
196
+ ### Usage
197
+
198
+ Once installed, you can run the `codefinder` command from your terminal:
199
+
200
+ ```bash
201
+ codefinder
202
+ ```
203
+
204
+ This will launch an interactive Gemini client that allows you to explore and search codebases using the provided MCP tools. Follow the on-screen prompts to interact with the client.
205
+
206
+ ---
207
+
178
208
  ## What the Server Provides (Tools)
179
209
 
180
210
  The MCP server exposes three safe, deterministic tools:
package/package.json CHANGED
@@ -9,7 +9,7 @@
9
9
  "zod": "^3.25.76"
10
10
  },
11
11
  "name": "@twahaa/codefinder",
12
- "version": "1.0.0",
12
+ "version": "1.0.1",
13
13
  "description": "MCP server and interactive Gemini client for exploring and searching codebases.",
14
14
  "main": "build/server.js",
15
15
  "exports": {