@gettymade/roux 0.1.2 → 0.1.3
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 +15 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -45,7 +45,7 @@ Roux is a platform of pluggable modules. GraphCore is the coordination hub—it
|
|
|
45
45
|
|
|
46
46
|
Same queries, same results—regardless of what's plugged in.
|
|
47
47
|
|
|
48
|
-
##
|
|
48
|
+
## Quick Start
|
|
49
49
|
|
|
50
50
|
Roux ships today with **DocStore**: point it at a markdown directory, query via MCP, edit in Obsidian.
|
|
51
51
|
|
|
@@ -56,12 +56,11 @@ npm install -g @gettymade/roux
|
|
|
56
56
|
# Initialize on your markdown directory
|
|
57
57
|
cd ~/my-notes
|
|
58
58
|
roux init
|
|
59
|
-
|
|
60
|
-
# Start the MCP server
|
|
61
|
-
roux serve
|
|
62
59
|
```
|
|
63
60
|
|
|
64
|
-
|
|
61
|
+
That's it. `roux init` creates a `.mcp.json` file that Claude Code detects automatically. The MCP server starts in the background when you open the project.
|
|
62
|
+
|
|
63
|
+
Then ask Claude things like:
|
|
65
64
|
- "Search my notes for distributed systems concepts"
|
|
66
65
|
- "What links to my note on consensus algorithms?"
|
|
67
66
|
- "Create a new note summarizing what I learned today"
|
|
@@ -74,7 +73,7 @@ Then ask your AI things like:
|
|
|
74
73
|
|
|
75
74
|
```bash
|
|
76
75
|
roux init [directory] # Initialize (creates roux.yaml, .roux/, .mcp.json)
|
|
77
|
-
roux serve [directory] # Start MCP server
|
|
76
|
+
roux serve [directory] # Start MCP server manually (for debugging or non-Claude clients)
|
|
78
77
|
roux serve --no-watch # Start without watching for changes
|
|
79
78
|
roux status [directory] # Show node/edge/embedding counts
|
|
80
79
|
roux viz [directory] # Generate interactive graph visualization
|
|
@@ -111,9 +110,16 @@ providers:
|
|
|
111
110
|
|
|
112
111
|
Embeddings use local transformers.js by default. No external services required.
|
|
113
112
|
|
|
114
|
-
### MCP
|
|
113
|
+
### Non-Claude MCP Clients
|
|
114
|
+
|
|
115
|
+
`roux init` creates `.mcp.json` which Claude Code reads automatically. Other MCP clients may need manual configuration:
|
|
115
116
|
|
|
116
|
-
|
|
117
|
+
```bash
|
|
118
|
+
# Option 1: Run the server manually
|
|
119
|
+
roux serve
|
|
120
|
+
|
|
121
|
+
# Option 2: Configure your client to spawn it (check your client's docs)
|
|
122
|
+
```
|
|
117
123
|
|
|
118
124
|
## Roadmap
|
|
119
125
|
|
|
@@ -140,7 +146,7 @@ See [implementation-plan.md](docs/implementation-plan.md) for details.
|
|
|
140
146
|
4. **Graph** — Builds in-memory graph from link relationships
|
|
141
147
|
5. **Serving** — Exposes operations via MCP protocol
|
|
142
148
|
|
|
143
|
-
File changes sync automatically when
|
|
149
|
+
File changes sync automatically when the MCP server is running.
|
|
144
150
|
|
|
145
151
|
## Documentation
|
|
146
152
|
|