ReIndex

The reindex distribution provides the ReIndex Python package and the rei CLI. reindex is also a CLI alias.

Install and initialize

Give an AI Agent this sentence:

Run uv tool install --upgrade reindex, then run rei init <data-directory> --agent <current-agent> to create or update the ReIndex skills.

The installation is complete when rei --help works directly, without uv run. pipx install reindex and python -m pip install reindex are also supported. Python 3.12 or newer is required; the Docling dependency makes the first installation and first PDF scan larger than a typical CLI.

<current-agent> is codex, claude, cursor, or copilot. init is idempotent, creates or reuses local identity, and installs or safely updates the three bundled skills. It does not scan, push, or download tutorial data.

rei init <collection-dir> [--name <name>] [--agent codex]
rei rename <collection-dir> <new-name>

Local commands

rei inspect <path>
rei scan <path> [--collection-root <collection-dir>]
rei check <path>

inspect is read-only. scan stages, validates, and atomically publishes a package. check verifies package resources, protected Node metadata, and current inputs.

For the normal author path, push runs the same package check again, so an explicit check is mainly useful after manually editing cards or in CI:

rei init <collection-dir> --name <name> --agent codex
rei inspect <collection-dir>
rei scan <collection-dir>
rei push <collection-dir> --api-url <api-url>

Remote commands

rei set-api <base-url>
rei push [path]
rei pull <name> [--output <directory>]
rei search "<query>" [--remote <name>] [--mode lexical|semantic|hybrid]
rei get <node-path> [--target card|source|content|asset]
rei get raw://<path>

push synchronously sends the complete validated package and exactly referenced raw sources. pull downloads only the complete .node.md tree. get checks a complete local package, local authoring source, and the SHA-256 cache before downloading one exact resource.

Collection names are the user-facing remote identifier. UUIDs remain internal stable identity. Resource logical paths stay Collection-relative and are scoped by the internal Collection UUID.

Skills

rei skills install --agent codex
rei skills update --agent codex
rei skills update --agent codex --force

Normal updates overwrite only unmodified ReIndex-managed copies. A modified skill reports a conflict unless --force is explicit.

Python API

The stable Python namespace is reindex. It currently exposes the HTTP client and installed package version; higher-level Collection APIs can grow here without changing the CLI implementation package.

from reindex import ApiClient, __version__

client = ApiClient("http://127.0.0.1:8000")
print(__version__, client.health())

The CLI does not include or provision a hosted API. Remote commands use the configured ReIndex API; without one, the default is the local development endpoint at http://127.0.0.1:8000.