{ "schema_version": 2, "id": "develop/setup", "title": "Get started", "url": "https://redis.io/docs/latest/develop/setup/", "summary": "Get Redis running and connect your first application, however you deploy it.", "tags": [], "last_updated": "2026-09-03T11:36:47-07:00", "children": [ { "id": "develop/setup/build-with-an-agent", "summary": "Connect AI agents to Redis documentation and give them Redis-specific skills.", "title": "Build with an agent", "url": "https://redis.io/docs/latest/develop/setup/build-with-an-agent/" } ], "page_type": "content", "content_hash": "0c3aeb6dcabb85a41f96cdb9ee156eb965f5a5ea63b13d52677619feb5633c1b", "sections": [ { "id": "overview", "title": "Overview", "role": "overview", "text": "In this guide, you'll learn how to create a Redis deployment in Redis Cloud, Redis Software, or Redis Open Source. Then, you'll learn how to create an application that connects to your deployment." }, { "id": "create-a-redis-deployment", "title": "Create a Redis deployment", "role": "content", "text": "This section shows how to set up a Redis deployment and connect to it with `redis-cli`.\n\n1. Install dependencies\n\n Before you begin, install the following dependencies in your development environment:\n\n - **[`redis-cli`](https://redis.io/docs/latest/develop/tools/cli)**: command-line tool that connects to a deployment and runs Redis commands\n - **[Docker](https://docs.docker.com/get-docker/)**: platform that runs software in containers, including local Redis deployments\n\n Select the tab corresponding to your deployment method to see which of these you need.\n\n **Redis Cloud:**\n\n- A web browser, to sign up and manage your database in the [Redis Cloud console](https://cloud.redis.io).\n - `redis-cli` installed locally, to connect to your database in step 3:\n\n [code example]\n\n See [Install redis-cli](https://redis.io/docs/latest/operate/oss_and_stack/install/install-stack/install-redis-cli) for more information.\n\n**Redis Software:**\n\n- [Docker](https://docs.docker.com/get-docker/) installed, to run the Docker quick start in step 2. To install without Docker, see the [Redis Software on Linux quick start](https://redis.io/docs/latest/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart) for its own system requirements.\n - A command-line HTTP client such as `curl`, if you want to create a database with the REST API in step 2.\n\n**Redis Open Source:**\n\n- [Docker](https://docs.docker.com/get-docker/) installed, to run the Docker quick start in step 2. To install without Docker, see [Install Redis on Linux, macOS, or from source](https://redis.io/docs/latest/operate/oss_and_stack/install/install-stack) for its own system requirements.\n\n\n\n2. Set up a fully-featured deployment\n\n Select the tab corresponding to your deployment method and follow its instructions to deploy Redis and create a database.\n\n **Redis Cloud:**\n\n[Sign up and create your database](https://redis.io/try-free/). Signing up creates a free 30 MB database for you.\n\n To create additional or different types of databases from the console, see:\n\n - [Create an Essentials database](https://redis.io/docs/latest/operate/rc/databases/create-database/create-essentials-database) — a cost-efficient, fully managed database for low-throughput workloads, training, and prototyping.\n - [Create a Pro database](https://redis.io/docs/latest/operate/rc/databases/create-database/create-pro-database-new) — a dedicated, \"pay as you go\" database for production workloads that need higher throughput, larger datasets, and advanced features like Active-Active and clustering.\n\n**Redis Software:**\n\n[Redis Software](https://redis.io/docs/latest/operate/rs/) is a self-managed Redis cluster you install and run on your own infrastructure. The fastest way to try it is with Docker:\n\n [code example]\n\n See the [Redis Software on Docker quick start](https://redis.io/docs/latest/operate/rs/installing-upgrading/quickstarts/docker-quickstart) for the full procedure, or the [Redis Software on Linux quick start](https://redis.io/docs/latest/operate/rs/installing-upgrading/quickstarts/redis-enterprise-software-quickstart) to install without Docker.\n\n You can create databases with Redis Software using the console or the REST API. To create a database with the REST API:\n\n [code example]\n\n See [Create a database](https://redis.io/docs/latest/operate/rs/databases/create) for the full procedure, including the console method and additional configuration fields.\n\n**Redis Open Source:**\n\n[Redis Open Source](https://redis.io/docs/latest/operate/oss_and_stack/) is the free, self-managed core Redis server. The fastest way to run it is with Docker:\n\n [code example]\n\n Starting the server creates your database — there's no separate create step. See [Run Redis on Docker](https://redis.io/docs/latest/operate/oss_and_stack/install/install-stack/docker) for the full procedure, or [Install Redis on Linux, macOS, or from source](https://redis.io/docs/latest/operate/oss_and_stack/install/install-stack) to install without Docker.\n\n\n\n3. Connect to your deployment\n\n You can connect to your deployment with `redis-cli`. Select the tab corresponding to your deployment method.\n\n **Redis Cloud:**\n\nGet your database's host, port, and password from the connection wizard in the [Redis Cloud console](https://cloud.redis.io), then connect with `redis-cli`:\n\n [code example]\n\n See [Connect to a Redis Cloud database](https://redis.io/docs/latest/operate/rc/databases/connect) for the full procedure, including Redis Insight and client library options.\n\n**Redis Software:**\n\nConnect to your Redis Software database using the following command:\n\n [code example]\n\n See [Connect to a Redis Software database](https://redis.io/docs/latest/operate/rs/databases/connect) for the full procedure and for further options, including Redis Insight and client library connections.\n\n**Redis Open Source:**\n\nIf you started Redis with the `docker run` command from step 2 then you can connect to the database with the following command:\n\n [code example]\n\n See [Redis CLI](https://redis.io/docs/latest/develop/tools/cli) for the full procedure, including non-Docker installs and [Redis Insight](https://redis.io/docs/latest/develop/tools/insight) as a GUI alternative to the CLI.\n\n\n\nCongratulations! You have successfully set up your Redis deployment and connected to it.\n\nIn the next section, you'll learn how to create an application that connects to your deployment and interacts with data." }, { "id": "create-your-first-redis-application", "title": "Create your first Redis application", "role": "content", "text": "To connect to your Redis deployment in an application, you can use one of the official [Redis client libraries](https://redis.io/docs/latest/develop/clients).\n\nSelect your preferred programming language from the tabs in each step below.\n\n1. Load sample data\n\n Unlike some databases, Redis doesn't need a separate sample-data load step. The `SET` and `GET` commands in step 3 both create and read the sample data directly — there's no dataset to restore first.\n\n2. Initialize your application\n\n **Python:**\n\nCreate a project directory and [install redis-py](https://redis.io/docs/latest/develop/clients/redis-py/_index.md#install):\n\n [code example]\n\n**Node.js:**\n\nCreate a project directory and [install node-redis](https://redis.io/docs/latest/develop/clients/nodejs/_index.md#install):\n\n [code example]\n\n**Java:**\n\nAdd [Jedis](https://redis.io/docs/latest/develop/clients/jedis/_index.md) as a dependency in your Maven project's `pom.xml`:\n\n [code example]\n\n**Go:**\n\nCreate a project directory and [install go-redis](https://redis.io/docs/latest/develop/clients/go/_index.md):\n\n [code example]\n\n**C#:**\n\nCreate a project directory and [install StackExchange.Redis](https://redis.io/docs/latest/develop/clients/dotnet/_index.md):\n\n [code example]\n\n**Ruby:**\n\nCreate a project directory and [install redis-rb](https://redis.io/docs/latest/develop/clients/ruby/_index.md#install):\n\n [code example]\n\n**C:**\n\n[Build and install hiredis](https://redis.io/docs/latest/develop/clients/hiredis/_index.md#build-and-install) from source:\n\n [code example]\n\n**Rust:**\n\nCreate a project directory and [add the `redis` crate](https://redis.io/docs/latest/develop/clients/rust/_index.md#install) as a dependency in `Cargo.toml`:\n\n [code example]\n\n**PHP:**\n\nUse [Composer](https://redis.io/docs/latest/develop/clients/php/_index.md#install) to install Predis:\n\n [code example]\n\n**RedisVL:**\n\nCreate a project directory and [install RedisVL](https://redis.io/docs/latest/develop/ai/redisvl/install):\n\n [code example]\n\n\n\n3. Create your application\n\n **Python:**\n\nCopy the following code into `app.py`. This connects to your database and sets and retrieves a value.\n\n [code example]\n\n**Node.js:**\n\nCopy the following code into `index.js`. This connects to your database and sets and retrieves a value.\n\n [code example]\n\n**Java:**\n\nCopy the following code into `Main.java`. This connects to your database and sets and retrieves a value.\n\n [code example]\n\n**Go:**\n\nCopy the following code into `main.go`. This connects to your database and sets and retrieves a value.\n\n [code example]\n\n**C#:**\n\nCopy the following code into `Program.cs`. This connects to your database and sets and retrieves a value.\n\n [code example]\n\n**Ruby:**\n\nCopy the following code into `app.rb`. This connects to your database and sets and retrieves a value.\n\n [code example]\n\n**C:**\n\nCopy the following code into `main.c`. This connects to your database and sets and retrieves a value.\n\n [code example]\n\n**Rust:**\n\nCopy the following code into `src/main.rs`. This connects to your database and sets and retrieves a value.\n\n [code example]\n\n**PHP:**\n\nCopy the following code into `app.php`. This connects to your database and sets and retrieves a value.\n\n [code example]\n\n**RedisVL:**\n\nRedisVL is a vector-search library, not a general key-value client — it works with index schemas rather than simple `SET`/`GET` commands. Copy the following code into `app.py` to define a schema and create an index:\n\n [code example]\n\n See the [RedisVL getting started guide](https://redis.io/docs/latest/develop/ai/redisvl/user_guide/getting_started) for the full procedure, including loading data and running vector searches.\n\n\n\n4. Add your connection string\n\n The examples in step 3 connect to `localhost:6379`. Replace that with your actual deployment's host, port, and password — from the [Redis Cloud connection wizard](https://cloud.redis.io), the [Redis Software connection details](https://redis.io/docs/latest/operate/rs/databases/connect), or `localhost:6379` if you're already running Redis Open Source locally.\n\n **Python:**\n\n[code example]\n\n**Node.js:**\n\n[code example]\n\n**Java:**\n\n[code example]\n\n**Go:**\n\n[code example]\n\n**C#:**\n\n[code example]\n\n**Ruby:**\n\n[code example]\n\n**C:**\n\n`hiredis` connects by host and port, then authenticates with a separate command:\n\n [code example]\n\n**Rust:**\n\n[code example]\n\n**PHP:**\n\n[code example]\n\n**RedisVL:**\n\n[code example]\n\n\n\n5. Run your application\n\n **Python:**\n\n[code example]\n\n**Node.js:**\n\n[code example]\n\n**Java:**\n\n[code example]\n\n**Go:**\n\n[code example]\n\n**C#:**\n\n[code example]\n\n**Ruby:**\n\n[code example]\n\n**C:**\n\n[code example]\n\n**Rust:**\n\n[code example]\n\n**PHP:**\n\n[code example]\n\n**RedisVL:**\n\n[code example]\n\n\n\n Each program prints `Process 134` — the value you stored and then retrieved. (RedisVL's example instead confirms the index was created.)\n\n6. Explore a use case\n\n Each of the following quick starts shows a complete example application for a specific use case:\n\n - [Data structure store](https://redis.io/docs/latest/develop/get-started/data-store)\n - [Document database](https://redis.io/docs/latest/develop/get-started/search-tutorial)\n - [Vector database](https://redis.io/docs/latest/develop/get-started/search-tutorial/vector-search)\n\n Refer to the [Redis use cases](https://redis.io/docs/latest/develop/use-cases) page for a complete set of use cases with code examples in your programming language." }, { "id": "next-steps", "title": "Next steps", "role": "content", "text": "To learn more about developing with Redis, see the following resources:\n\n- [Explore all client libraries](https://redis.io/docs/latest/develop/clients)\n- [Redis products overview](https://redis.io/docs/latest/operate/)\n- [Develop with Redis](https://redis.io/docs/latest/develop/)" } ], "examples": [ { "id": "create-a-redis-deployment-ex0", "language": "sh", "code": "curl -fsSL https://packages.redis.io/redis-cli/install.sh | sh", "section_id": "create-a-redis-deployment" }, { "id": "create-a-redis-deployment-ex1", "language": "sh", "code": "docker run -d --cap-add sys_resource --name RE -p 8443:8443 -p 9443:9443 -p 12000:12000 redislabs/redis", "section_id": "create-a-redis-deployment" }, { "id": "create-a-redis-deployment-ex2", "language": "sh", "code": "POST https://:/v1/bdbs\n {\n \"name\": \"test-database\",\n \"type\": \"redis\",\n \"memory_size\": 1073741824,\n // Additional fields\n }", "section_id": "create-a-redis-deployment" }, { "id": "create-a-redis-deployment-ex3", "language": "sh", "code": "docker run -d --name redis -p 6379:6379 redis:latest", "section_id": "create-a-redis-deployment" }, { "id": "create-a-redis-deployment-ex4", "language": "sh", "code": "redis-cli -h -p -a ", "section_id": "create-a-redis-deployment" }, { "id": "create-a-redis-deployment-ex5", "language": "sh", "code": "docker exec -it redis-cli -h -p ", "section_id": "create-a-redis-deployment" }, { "id": "create-a-redis-deployment-ex6", "language": "sh", "code": "docker exec -it redis redis-cli", "section_id": "create-a-redis-deployment" }, { "id": "create-your-first-redis-application-ex0", "language": "sh", "code": "mkdir python-quickstart\n cd python-quickstart\n pip install redis", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex1", "language": "sh", "code": "mkdir node-quickstart\n cd node-quickstart\n npm init -y\n npm install redis", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex2", "language": "xml", "code": "\n redis.clients\n jedis\n 7.2.0\n ", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex3", "language": "sh", "code": "mkdir go-quickstart\n cd go-quickstart\n go mod init go-quickstart\n go get github.com/redis/go-redis/v9", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex4", "language": "sh", "code": "mkdir csharp-quickstart\n cd csharp-quickstart\n dotnet new console\n dotnet add package StackExchange.Redis", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex5", "language": "sh", "code": "mkdir ruby-quickstart\n cd ruby-quickstart\n gem install redis", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex6", "language": "sh", "code": "git clone https://github.com/redis/hiredis.git\n cd hiredis\n make\n sudo make install", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex7", "language": "toml", "code": "[dependencies]\n redis = \"1.0.4\"", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex8", "language": "sh", "code": "composer require predis/predis", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex9", "language": "sh", "code": "mkdir redisvl-quickstart\n cd redisvl-quickstart\n pip install redisvl", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex10", "language": "python", "code": "import redis\n\n r = redis.Redis(host='localhost', port=6379, decode_responses=True)\n\n r.set('bike:1', 'Process 134')\n print(r.get('bike:1'))", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex11", "language": "js", "code": "import { createClient } from 'redis';\n\n const client = createClient();\n client.on('error', err => console.log('Redis Client Error', err));\n await client.connect();\n\n await client.set('bike:1', 'Process 134');\n const value = await client.get('bike:1');\n console.log(value);", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex12", "language": "java", "code": "package org.example;\n import redis.clients.jedis.RedisClient;\n\n public class Main {\n public static void main(String[] args) {\n RedisClient jedis = RedisClient.create(\"redis://localhost:6379\");\n\n String res1 = jedis.set(\"bike:1\", \"Process 134\");\n System.out.println(res1);\n\n String res2 = jedis.get(\"bike:1\");\n System.out.println(res2);\n\n jedis.close();\n }\n }", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex13", "language": "go", "code": "package main\n\n import (\n \"context\"\n \"fmt\"\n \"github.com/redis/go-redis/v9\"\n )\n\n func main() {\n ctx := context.Background()\n client := redis.NewClient(&redis.Options{\n Addr: \"localhost:6379\",\n })\n\n if err := client.Set(ctx, \"bike:1\", \"Process 134\", 0).Err(); err != nil {\n panic(err)\n }\n\n val, err := client.Get(ctx, \"bike:1\").Result()\n if err != nil {\n panic(err)\n }\n fmt.Println(val)\n }", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex14", "language": "csharp", "code": "using StackExchange.Redis;\n\n ConnectionMultiplexer redis = ConnectionMultiplexer.Connect(\"localhost:6379\");\n IDatabase db = redis.GetDatabase();\n\n db.StringSet(\"bike:1\", \"Process 134\");\n Console.WriteLine(db.StringGet(\"bike:1\"));", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex15", "language": "ruby", "code": "require 'redis'\n\n r = Redis.new\n\n r.set('bike:1', 'Process 134')\n puts r.get('bike:1')", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex16", "language": "c", "code": "#include \n #include \n #include \n\n int main() {\n redisContext *c = redisConnect(\"127.0.0.1\", 6379);\n if (c == NULL || c->err) {\n printf(\"Connection error\\n\");\n exit(1);\n }\n\n redisReply *reply = redisCommand(c, \"SET bike:1 %s\", \"Process 134\");\n printf(\"%s\\n\", reply->str);\n freeReplyObject(reply);\n\n reply = redisCommand(c, \"GET bike:1\");\n printf(\"%s\\n\", reply->str);\n freeReplyObject(reply);\n\n redisFree(c);\n return 0;\n }", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex17", "language": "rust", "code": "use redis::Commands;\n\n fn main() -> redis::RedisResult<()> {\n let client = redis::Client::open(\"redis://127.0.0.1:6379\")?;\n let mut con = client.get_connection()?;\n\n con.set(\"bike:1\", \"Process 134\")?;\n let value: String = con.get(\"bike:1\")?;\n println!(\"{value}\");\n\n Ok(())\n }", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex18", "language": "php", "code": " 'tcp',\n 'host' => '127.0.0.1',\n 'port' => 6379,\n ]);\n\n $client->set('bike:1', 'Process 134');\n echo $client->get('bike:1') . PHP_EOL;", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex19", "language": "python", "code": "from redisvl.index import SearchIndex\n\n schema = {\n \"index\": {\"name\": \"bikes\", \"prefix\": \"bike\"},\n \"fields\": [\n {\"name\": \"model\", \"type\": \"text\"},\n {\"name\": \"price\", \"type\": \"numeric\"},\n ],\n }\n\n index = SearchIndex.from_dict(schema, redis_url=\"redis://localhost:6379\")\n index.create(overwrite=True)", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex20", "language": "python", "code": "r = redis.from_url(\"redis://default:@:\")", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex21", "language": "js", "code": "const client = createClient({\n url: 'redis://default:@:'\n });", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex22", "language": "java", "code": "RedisClient jedis = RedisClient.create(\"redis://default:@:\");", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex23", "language": "go", "code": "opt, err := redis.ParseURL(\"redis://default:@:\")\n if err != nil {\n panic(err)\n }\n client := redis.NewClient(opt)", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex24", "language": "csharp", "code": "ConfigurationOptions conf = new ConfigurationOptions {\n EndPoints = { \":\" },\n User = \"default\",\n Password = \"\"\n };\n ConnectionMultiplexer redis = ConnectionMultiplexer.Connect(conf);", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex25", "language": "ruby", "code": "r = Redis.new(url: \"redis://default:@:\")", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex26", "language": "c", "code": "redisContext *c = redisConnect(\"\", );\n redisReply *reply = redisCommand(c, \"AUTH %s\", \"\");\n freeReplyObject(reply);", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex27", "language": "rust", "code": "let client = redis::Client::open(\"redis://default:@:\")?;", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex28", "language": "php", "code": "$client = new Client([\n 'scheme' => 'tcp',\n 'host' => '',\n 'port' => '',\n 'password' => '',\n ]);", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex29", "language": "python", "code": "index = SearchIndex.from_dict(schema, redis_url=\"redis://default:@:\")", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex30", "language": "sh", "code": "python app.py", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex31", "language": "sh", "code": "node index.js", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex32", "language": "sh", "code": "mvn compile exec:java -Dexec.mainClass=\"org.example.Main\"", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex33", "language": "sh", "code": "go run main.go", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex34", "language": "sh", "code": "dotnet run", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex35", "language": "sh", "code": "ruby app.rb", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex36", "language": "sh", "code": "cc main.c -L/usr/local/lib -lhiredis -o app\n ./app", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex37", "language": "sh", "code": "cargo run", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex38", "language": "sh", "code": "php app.php", "section_id": "create-your-first-redis-application" }, { "id": "create-your-first-redis-application-ex39", "language": "sh", "code": "python app.py", "section_id": "create-your-first-redis-application" } ] }