Quick Start
Quick Start
By the end of this guide, you'll have Indexed installed, a collection of local documents indexed, and a working semantic search — all in under 5 minutes.
Install Indexed
pipx install indexedDon't have pipx?
Run pip install pipx && pipx ensurepath first, then restart your terminal. See Installation for alternative methods.
Initialize Your Workspace
indexed config init --yes✓ Created config at ~/.indexed/config.tomlThis creates the ~/.indexed/ directory where all your collections and configuration will live.
Index a Folder
Point Indexed at any folder with documents — your project's docs/ directory, a folder of markdown files, or even just a directory with a few READMEs.
indexed index create files -c my-docs -p ./docsIndexing collection 'my-docs'...
Parsed 12 documents
Created 47 chunks
Generated embeddings
✓ Collection 'my-docs' created (47 chunks, 3.2 MB)No docs folder handy?
Use any directory with text files. Indexed supports PDF, DOCX, Markdown, TXT, HTML, and many more formats.
Search It
indexed index search "authentication guide"Results for 'authentication guide' (top 5):
1. [my-docs] auth-setup.md (chunk 2/4)
Score: 0.82
...To configure SSO authentication, first set up your identity
provider with the following SAML settings...
2. [my-docs] onboarding.md (chunk 5/8)
Score: 0.74
...New team members should request access through the auth
portal at auth.internal.company.com...Notice how the search found documents about "SSO authentication" and "access through the auth portal" — even though we searched for "authentication guide." That's semantic search at work.
Connect to Claude Desktop
Now make your indexed knowledge available to Claude Desktop via MCP.
Add this to your Claude Desktop config file:
Edit ~/Library/Application Support/Claude/claude_desktop_config.json:
{
"mcpServers": {
"indexed": {
"command": "indexed",
"args": ["mcp", "run"]
}
}
}Edit ~/.config/Claude/claude_desktop_config.json:
{
"mcpServers": {
"indexed": {
"command": "indexed",
"args": ["mcp", "run"]
}
}
}Restart Claude Desktop. Now try asking Claude something that your docs would know:
"What's the process for setting up SSO authentication?"
Claude will use Indexed's MCP tools to search your collection and answer using your actual documentation.