semantiq-mcp 0.2.2 → 0.2.4
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 +25 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,9 +10,24 @@ Semantiq gives every AI coding assistant semantic understanding of your codebase
|
|
|
10
10
|
npm install -g semantiq-mcp
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
##
|
|
13
|
+
## Quick Start (10 seconds)
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
```bash
|
|
16
|
+
cd /path/to/your/project
|
|
17
|
+
semantiq init
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
This automatically:
|
|
21
|
+
- Creates `.claude/settings.json` with MCP configuration
|
|
22
|
+
- Creates `CLAUDE.md` with tool instructions
|
|
23
|
+
- Updates `.gitignore` to exclude the index database
|
|
24
|
+
- Indexes your entire project
|
|
25
|
+
|
|
26
|
+
Restart Claude Code and you're ready to go!
|
|
27
|
+
|
|
28
|
+
## Manual Setup
|
|
29
|
+
|
|
30
|
+
If you prefer manual configuration, add to your MCP config (Claude Code, Cursor, etc.):
|
|
16
31
|
|
|
17
32
|
```json
|
|
18
33
|
{
|
|
@@ -25,7 +40,9 @@ Add to your MCP config (Claude Code, Cursor, etc.):
|
|
|
25
40
|
}
|
|
26
41
|
```
|
|
27
42
|
|
|
28
|
-
|
|
43
|
+
## Auto-Indexing
|
|
44
|
+
|
|
45
|
+
Semantiq automatically watches your project for file changes and updates the index in real-time. No manual reindexing needed.
|
|
29
46
|
|
|
30
47
|
## MCP Tools
|
|
31
48
|
|
|
@@ -39,7 +56,10 @@ That's it. Semantiq auto-detects your project and starts indexing.
|
|
|
39
56
|
## CLI Commands
|
|
40
57
|
|
|
41
58
|
```bash
|
|
42
|
-
#
|
|
59
|
+
# Initialize Semantiq for a project (recommended)
|
|
60
|
+
semantiq init
|
|
61
|
+
|
|
62
|
+
# Index a project manually
|
|
43
63
|
semantiq index /path/to/project
|
|
44
64
|
|
|
45
65
|
# Start MCP server
|
|
@@ -76,6 +96,7 @@ Works with all MCP-compatible tools:
|
|
|
76
96
|
## Links
|
|
77
97
|
|
|
78
98
|
- [GitHub Repository](https://github.com/so-keyldzn/semantiq)
|
|
99
|
+
- [Changelog](https://github.com/so-keyldzn/semantiq/blob/main/CHANGELOG.md)
|
|
79
100
|
- [Report Issues](https://github.com/so-keyldzn/semantiq/issues)
|
|
80
101
|
|
|
81
102
|
## License
|