Installation
Install the Indexed CLI via pipx, pip, Docker, or from source.
Installation
Prerequisites
- Python 3.10+ — check with
python3 --version - pip — usually included with Python
Install
pipx installs Indexed in an isolated environment so it won't conflict with other Python packages.
pip install pipx
pipx ensurepath
pipx install indexedRestart your terminal, then verify:
indexed --helppip install indexed
indexed --helpgit clone https://github.com/LennardZuendorf/indexed.git
cd indexed
uv syncSource installs use uv run
When installed from source, prefix all commands with uv run. For example: uv run indexed --help instead of indexed --help.
docker build -t indexed .
docker run indexed --helpSee Run with Docker for full Docker usage including MCP server setup.
Initialize Your Workspace
After installing, initialize the Indexed workspace:
indexed config init --yesThis creates ~/.indexed/config.toml with default settings. To customize the configuration interactively, omit --yes:
indexed config initSee the Configuration Reference for all available settings.