| layout | home | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| title | Probe Documentation | ||||||||||||||||||||||||||||
| hero |
|
Pick a path based on what you need to do.
| Goal | Read |
|---|---|
| Install and run Probe quickly | Quick Start, Installation |
| Understand major capabilities | Features |
| Use CLI commands directly | CLI Reference |
| Use Agent / MCP / SDK | Probe Agent Overview |
| Use LSP and indexing | LSP Features, LSP Quick Reference |
| Document | Description |
|---|---|
| Search | Semantic code search and query syntax |
| Extract | Block extraction by line, range, symbol, or stdin/diff |
| Symbols | File symbol tree / table of contents with line numbers |
| Query | AST-grep structural search |
| CLI Reference | Command matrix and options |
| Document | Description |
|---|---|
| LSP Features | What --lsp adds and when to use it |
| LSP Quick Reference | Fast command cheat sheet |
| Indexing Overview | Indexing model and workflows |
| Indexing CLI Reference | probe lsp index* command details |
| Document | Description |
|---|---|
| Agent Overview | Platform overview and usage modes |
| AI Integration | Providers, auth, and integration patterns |
| MCP Integration | Editor integration setup |
| Node.js SDK | Programmatic usage |
| LLM Script | Deterministic multi-step orchestration |
| Document | Description |
|---|---|
| Architecture | System architecture |
| How It Works | Pipeline and internals |
| Environment Variables | Runtime configuration |
| Output Formats | JSON/XML/plain/markdown formats |
| Language Support | Parsing/extraction behavior by language |
| Supported Languages | File extensions and language matrix |
| Troubleshooting | Common issues and fixes |