{
  "id": "installation",
  "title": "Install RedisVL",
  "url": "https://redis.io/docs/latest/develop/ai/redisvl/0.11.0/overview/installation/",
  "summary": "",
  "content": "\n\nThere are a few ways to install RedisVL. The easiest way is to use pip.\n\n## Install RedisVL with Pip\n\nInstall `redisvl` into your Python (\u003e=3.8) environment using `pip`:\n\n```bash\n$ pip install -U redisvl\n```\n\nRedisVL comes with a few dependencies that are automatically installed, however, a few dependencies\nare optional and can be installed separately if needed:\n\n```bash\n$ pip install redisvl[all]  # install vectorizer dependencies\n$ pip install redisvl[dev]  # install dev dependencies\n```\n\nIf you use ZSH, remember to escape the brackets:\n\n```bash\n$ pip install redisvl\\[all\\]\n```\n\nThis library supports the use of hiredis, so you can also install by running:\n\n```bash\npip install redisvl[hiredis]\n```\n\n## Install RedisVL from Source\n\nTo install RedisVL from source, clone the repository and install the package using `pip`:\n\n```bash\n$ git clone https://github.com/redis/redis-vl-python.git \u0026\u0026 cd redisvl\n$ pip install .\n\n# or for an editable installation (for developers of RedisVL)\n$ pip install -e .\n```\n\n## Installing Redis\n\nRedisVL requires a distribution of Redis that supports the [Search and Query](https://redis.com/modules/redis-search/) capability of which there are 3:\n\noffering\n\n1. [Redis Cloud](https://redis.io/cloud), a fully managed cloud offering\n2. [Redis Stack](https://redis.io/docs/getting-started/install-stack/docker/), a local docker image for testing and development\n3. [Redis Software](https://redis.com/redis-enterprise/), a commercial self-hosted\n\n### Redis Cloud\n\nRedis Cloud is the easiest way to get started with RedisVL. You can sign up for a free account [here](https://redis.io/cloud). Make sure to have the `Search and Query`\ncapability enabled when creating your database.\n\n### Redis Stack (local development)\n\nFor local development and testing, Redis-Stack can be used. We recommend running Redis\nin a docker container. To do so, run the following command:\n\n```bash\ndocker run -d --name redis-stack -p 6379:6379 -p 8001:8001 redis/redis-stack:latest\n```\n\nThis will also spin up the [Redis Insight GUI](https://redis.io/insight/) at `http://localhost:8001`.\n\n### Redis Software (self-hosted)\n\nRedis Software is a commercial offering that can be self-hosted. You can download the latest version [here](https://redis.io/downloads/).\n\nIf you are considering a self-hosted Redis Software deployment on Kubernetes, there is the [Redis Software Operator](https://docs.redis.com/latest/kubernetes/) for Kubernetes. This will allow you to easily deploy and manage a Redis Software cluster on Kubernetes.\n\n### Redis Sentinel\n\nFor high availability deployments, RedisVL supports connecting to Redis through Sentinel. Use the `redis+sentinel://` URL scheme to connect:\n\n```python\nfrom redisvl.index import SearchIndex\n\n# Connect via Sentinel\n# Format: redis+sentinel://[username:password@]host1:port1,host2:port2/service_name[/db]\nindex = SearchIndex.from_yaml(\n    \"schema.yaml\",\n    redis_url=\"redis+sentinel://sentinel1:26379,sentinel2:26379/mymaster\"\n)\n\n# With authentication\nindex = SearchIndex.from_yaml(\n    \"schema.yaml\",\n    redis_url=\"redis+sentinel://user:pass@sentinel1:26379,sentinel2:26379/mymaster/0\"\n)\n```\n\nThe Sentinel URL format supports:\n\n- Multiple sentinel hosts (comma-separated)\n- Optional authentication (username:password)\n- Service name (required - the name of the Redis master)\n- Optional database number (defaults to 0)\n",
  "tags": [],
  "last_updated": "2026-04-08T12:21:52-07:00"
}