Skip to content

Commit 5a5652b

Browse files
authored
Merge pull request #2 from O-Labz/readme-updates
added installation md and updated readme
2 parents 46be550 + 587b72c commit 5a5652b

2 files changed

Lines changed: 340 additions & 67 deletions

File tree

README.md

Lines changed: 1 addition & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -35,44 +35,7 @@ Context-Simplo is a production-ready **context database** and **MCP (Model Conte
3535

3636
## Quickstart
3737

38-
Context-Simplo runs in Docker. Choose your preferred method below.
39-
40-
### Option A: simplo CLI (Recommended)
41-
42-
The `simplo` CLI wraps Docker and handles mounting, LLM config, and IDE setup in a single command.
43-
44-
**Step 1: Install the CLI**
45-
```bash
46-
curl -fsSL https://raw.githubusercontent.com/ohopson/context-simplo/main/bin/simplo \
47-
-o /usr/local/bin/simplo && chmod +x /usr/local/bin/simplo
48-
```
49-
50-
**Step 2: (Optional) Configure an embedding provider**
51-
```bash
52-
simplo config
53-
# Edit the file to set LLM_PROVIDER, LLM_BASE_URL, etc.
54-
# Default is LLM_PROVIDER=ollama — make sure Ollama is running.
55-
# Set LLM_PROVIDER=none to skip embeddings (structural tools still work).
56-
```
57-
58-
**Step 3: Start from any project directory**
59-
```bash
60-
cd ~/projects/my-app
61-
simplo start
62-
```
63-
64-
**Step 4: Open the dashboard and configure your IDE**
65-
```bash
66-
open http://localhost:3001 # Dashboard
67-
simplo setup cursor # Generate .cursor/mcp.json
68-
# Also supports: vscode, claude-desktop, claude-code
69-
```
70-
71-
The CLI mounts your home directory read-only and calculates the workspace path automatically. Switch projects at any time from the dashboard — no container restart required.
72-
73-
### Option B: Docker CLI
74-
75-
If you prefer raw Docker commands, choose an embedding provider below.
38+
Context-Simplo runs in Docker. Choose an embedding provider below.
7639

7740
> **Important**: Context-Simplo does NOT bundle AI models. Provide an external embedding service for semantic search, or run with `LLM_PROVIDER=none` for structural tools only.
7841
@@ -262,12 +225,6 @@ Context-Simplo supports two workspace modes:
262225

263226
Mount your home directory at `/host`. The container can browse any subdirectory, and you can switch projects at runtime from the dashboard without restarting.
264227

265-
```bash
266-
# simplo CLI does this automatically:
267-
simplo start # indexes current directory
268-
simplo start ~/other-app # indexes a specific directory
269-
```
270-
271228
To switch workspaces at runtime, open the dashboard Repositories page and click **Change** in the workspace bar. Browse to a new directory and click **Switch Workspace**. Re-indexing happens automatically in the background.
272229

273230
### Legacy mode
@@ -292,23 +249,6 @@ When adding repositories via the dashboard or MCP tools, use **container paths**
292249

293250
The dashboard **Browse** tab shows the container filesystem — click to select.
294251

295-
## CLI Reference
296-
297-
The `simplo` CLI manages the Docker container lifecycle. Config is stored in `~/.config/context-simplo/config`.
298-
299-
| Command | Description |
300-
|---------|-------------|
301-
| `simplo start [path]` | Start container (workspace defaults to current dir) |
302-
| `simplo stop` | Stop and remove container |
303-
| `simplo restart` | Restart container |
304-
| `simplo status` | Show container status and current workspace |
305-
| `simplo logs` | Tail container logs |
306-
| `simplo update` | Pull latest image and restart |
307-
| `simplo config` | Edit persistent LLM configuration |
308-
| `simplo setup <ide>` | Generate MCP config (`cursor`, `vscode`, `claude-desktop`, `claude-code`) |
309-
310-
Options: `--root <path>` (mount root, default `$HOME`), `--port <port>` (default `3001`).
311-
312252
## Automatic AI Agent Usage (Cursor Rules)
313253

314254
Context-Simplo tools are most effective when your AI agent uses them automatically instead of falling back to file-by-file search. Add a Cursor rule that instructs the agent to prefer Context-Simplo for code intelligence tasks — reducing tool call chains and lowering token costs.
@@ -416,7 +356,6 @@ Context-Simplo runs on all major platforms via Docker:
416356
- **Web Dashboard** -- Setup wizard, graph explorer, real-time metrics, workspace switcher, MCP config generator
417357
- **Real-Time Updates** -- WebSocket broadcasting for live indexing progress and metrics
418358
- **REST API** -- Full-featured API for external integrations and automation
419-
- **`simplo` CLI** -- One-command Docker management with persistent config and IDE setup
420359
- **Local or Remote LLMs** -- OpenAI, Azure, Ollama, or run without LLM (structural tools still work)
421360
- **Production-Ready** -- Graceful shutdown, crash recovery, secret scrubbing, pagination
422361
- **Portable** -- Single Docker container, ~150-200MB image, SQLite + LanceDB embedded storage
@@ -437,11 +376,6 @@ Context-Simplo combines the speed of Arbor's Rust architecture with the rich too
437376
Full documentation available in the [`docs/`](docs/) directory:
438377

439378
- [Installation Guide](docs/installation.md)
440-
- [MCP IDE Setup](docs/mcp-setup.md)
441-
- [Configuration Reference](docs/configuration.md)
442-
- [MCP Tools Reference](docs/mcp-tools.md)
443-
- [Architecture Overview](docs/architecture.md)
444-
- [Development Guide](docs/CONTRIBUTING.md)
445379

446380
## License
447381

0 commit comments

Comments
 (0)