Skip to main content

Installation

Install Python and pip​

To follow the steps in this guide, you'll need:

  1. Install Python. We support Python 3.11 to 3.13.
  2. Install pip - a Python package installer

Install CocoIndex​

note

CocoIndex v1 is currently in preview (pre-release on PyPI). You need to allow pre-release versions when installing.

Using pip​

pip install -U --pre cocoindex

Using uv​

uv add --prerelease explicit cocoindex

Or add to your pyproject.toml:

[tool.uv]
prerelease = "explicit"

Using Poetry​

poetry add cocoindex --allow-prereleases

Or specify in pyproject.toml:

[tool.poetry.dependencies]
cocoindex = { version = "^1.0", allow-prereleases = true }

System requirements​

CocoIndex is supported on the following operating systems:

  • macOS: 10.12+ on x86_64, 11.0+ on arm64
  • Linux: x86_64 or arm64, glibc 2.28+ (e.g., Debian 10+, Ubuntu 18.10+, Fedora 29+, CentOS/RHEL 8+)
  • Windows: 10+ on x86_64