Skip to main content

ReIndex CLI

rei builds local files into ReIndex 1.0 packages and connects them to a ReIndex API. reindex is an alias.

Install and initialize

Give an AI Agent this sentence:

Run uv tool install --upgrade reindex-cli, 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-cli and python -m pip install reindex-cli 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.

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reindex_cli-0.3.0.tar.gz (34.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

reindex_cli-0.3.0-py3-none-any.whl (47.6 kB view details)

Uploaded Python 3

File details

Details for the file reindex_cli-0.3.0.tar.gz.

File metadata

  • Download URL: reindex_cli-0.3.0.tar.gz
  • Upload date:
  • Size: 34.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for reindex_cli-0.3.0.tar.gz
Algorithm Hash digest
SHA256 3552cfbb7aa70839656ea9f00f27ac62edd4b40d27686ecb728daa465fa34aee
MD5 2d22f78c63eefdeddca475c93bfa227d
BLAKE2b-256 11df99d8e19f6ce2b92f2f1542f31236ab44e936f488fababcb56ca80b007f56

See more details on using hashes here.

File details

Details for the file reindex_cli-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: reindex_cli-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 47.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for reindex_cli-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0afa1fc2557c0af263291d2a4b706e165a36b270ee52c452e6c5aad4b3097d4d
MD5 fe77e66bbc39f8e5513792f85eba6e28
BLAKE2b-256 5b434f9f670ab66f3fa9645ccb07196342133467e2f74704d7cd7b3107e2fe0c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page