ctxd 0.1.12

Public Python SDK and CLI for the ctxd platform.

ctxd

Public Python SDK and CLI for the ctxd platform.

Install:

pip install ctxd

The SDK exposes sync and async clients:

• Client
• AsyncClient

Authentication:

1. Preferred for headless and scripts: create a user-bound API key through the authenticated application backend
2. For CLI automation, set CTXD_API_KEY
3. The SDK sends that key as the bearer token directly to the MCP server
4. ctxd login prompts for an API key interactively and stores it in plaintext in the ctxd config directory for future CLI and SDK usage
5. ctxd status checks whether an API key is available from the active authentication source

CLI manual:

export CTXD_API_KEY=...       # Use env-based auth for this shell/session
ctxd --version                # Print the installed ctxd version
ctxd login                    # Prompt for an API key and store it
ctxd status                   # Check whether an API key is configured
ctxd install-app              # Open the app installation page
ctxd search "text:deployment"
ctxd search text:test application:slack
ctxd fetch doc-123
ctxd profile
ctxd logout                   # Remove the stored API key

CTXD_API_KEY does not require ctxd login. Commands such as ctxd search, ctxd fetch, and ctxd profile use the environment variable directly when it is set.

Stored login credentials are written in plaintext to ~/.ctxd/credentials.json by default. Set CTXD_CREDENTIALS_PATH to override that location.

Base URL resolution order:

1. base_url= passed to the client
2. CTXD_BASE_URL
3. ~/.ctxd/config.json
4. https://mcp.ctxd.dev

Example:

from ctxd import Client

client = Client(api_key="297e24c4-4ee9-4739-828f-48f57f48ce11")

results = client.search("text:deployment application:slack")
profile = client.get_profile()
document = client.fetch_document("doc-123")

API key example:

from ctxd import Client

client = Client(api_key="297e24c4-4ee9-4739-828f-48f57f48ce11")
results = client.search("text:deployment application:slack")

Async example:

from ctxd import AsyncClient

async with AsyncClient(api_key="297e24c4-4ee9-4739-828f-48f57f48ce11") as client:
    results = await client.search("text:deployment")