Installation

Requires Python 3.11 or later.

Base install

The base package includes the full x-vec SDK — encrypted vector storage, retrieval, execution context management, and the Ollama and OpenAI embedding providers:

pip install xtrace-ai-sdk

Optional extras

`[embedding]` — Sentence Transformers

Adds local embedding support via Sentence Transformers. Models are downloaded from Hugging Face on first use. Ollama and any OpenAI API-compatible embedding service (including OpenAI, Redpill, and Anthropic) are supported out of the box in the base install — no extra flag needed. Only install this extra if you want to use Sentence Transformers directly:

pip install "xtrace-ai-sdk[embedding]"

`[cli]` — Interactive CLI

Adds the xtrace command-line interface — an interactive shell for managing knowledge bases, loading data, and running queries without writing Python:

pip install "xtrace-ai-sdk[cli]"

See the CLI quickstart for setup and usage.

Combined

Extras can be combined:

pip install "xtrace-ai-sdk[embedding,cli]"

Install from source

git clone https://github.com/XTraceAI/xtrace-vec-sdk.git
cd xtrace-vec-sdk
pip install -e .

To include extras:

pip install -e ".[embedding,cli]"

Getting started

Core features

CLI

Reference

Base install

Optional extras

`[embedding]` — Sentence Transformers

`[cli]` — Interactive CLI

Combined

Install from source

​Base install

​Optional extras

​[embedding] — Sentence Transformers

​[cli] — Interactive CLI

​Combined

​Install from source

Base install

Optional extras

`[embedding]` — Sentence Transformers

`[cli]` — Interactive CLI

Combined

Install from source