ownsearch 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.
- package/README.md +23 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -24,14 +24,36 @@ V1 is intentionally text-first: simple, reliable local retrieval for docs, code,
|
|
|
24
24
|
|
|
25
25
|
## Quickstart
|
|
26
26
|
|
|
27
|
+
Install `ownsearch` globally:
|
|
28
|
+
|
|
27
29
|
```bash
|
|
30
|
+
npm install -g ownsearch
|
|
31
|
+
|
|
32
|
+
Set it up, index a folder, and start searching:
|
|
33
|
+
|
|
34
|
+
ownsearch setup
|
|
35
|
+
ownsearch doctor
|
|
36
|
+
ownsearch index ./docs --name docs
|
|
37
|
+
ownsearch list-roots
|
|
38
|
+
ownsearch search "what is this repo about?" --limit 5
|
|
39
|
+
ownsearch search-context "what is this repo about?" --limit 8 --max-chars 12000
|
|
40
|
+
ownsearch serve-mcp
|
|
41
|
+
|
|
42
|
+
To connect ownsearch to a supported agent, print a config snippet for your client:
|
|
43
|
+
|
|
44
|
+
ownsearch print-agent-config codex
|
|
45
|
+
ownsearch print-agent-config claude-desktop
|
|
46
|
+
ownsearch print-agent-config cursor
|
|
47
|
+
Local development
|
|
48
|
+
|
|
49
|
+
If you want to run ownsearch from source while developing locally:
|
|
50
|
+
|
|
28
51
|
npm install
|
|
29
52
|
npm run build
|
|
30
53
|
node dist/cli.js setup
|
|
31
54
|
node dist/cli.js index ./docs --name docs
|
|
32
55
|
node dist/cli.js search "what is this repo about?" --limit 5
|
|
33
56
|
node dist/cli.js serve-mcp
|
|
34
|
-
````
|
|
35
57
|
|
|
36
58
|
## MCP tools
|
|
37
59
|
|