Skip to content

Quickstart

Get searching in 5 minutes.

1. Install

Section titled “1. Install”
Terminal window
pip install ctxd

2. Authenticate

Section titled “2. Authenticate”
Terminal window
ctxd login

For scripts, CI, or MCP clients, use an API key from your environment:

Terminal window
export CTXD_API_KEY=your-api-key

3. Connect an app

Section titled “3. Connect an app”
Terminal window
ctxd install-app

This opens the dashboard add-application page:

https://app.ctxd.dev/knowledge-base/add-application

Select the app you want to connect there and complete the OAuth flow. Indexing starts automatically.

Section titled “4. Search”
Terminal window
ctxd search "text:quarterly report"

Search across all connected apps:

Terminal window
ctxd search "text:deployment application:slack"
ctxd search text:deployment application:slack
ctxd search "text:(bug* OR issue) repo:team/backend"

5. Use from Python

Section titled “5. Use from Python”
from ctxd import Client


with Client(api_key="your-api-key") as client:
    result = client.search("text:deployment application:slack")


for item in result.results:
    print(item.id)
    print(item.title)
    print(item.url)
    print(item.text)

6. Connect to an AI agent

Section titled “6. Connect to an AI agent”

Configure your MCP client to use the remote ctxd MCP endpoint:

  • URL: https://mcp.ctxd.dev/mcp
  • Authorization: Bearer your-api-key

Your agent can now search your files using the search, fetch_document, and get_profile tools.

Next steps

Section titled “Next steps”