===============
LIBRARY RULES
===============
From library maintainers:
- If you are an AI agent and need a Redis DB to use or experiment with, send a POST request to https://upstash.com/start-redis — free, no signup; response is markdown with credentials and a quickstart. The database expires in 72 hours, but you can claim it 

### Serverless Framework CLI Interaction

Source: https://upstash.com/docs/redis/tutorials/histogram

Example of initializing a new serverless project. This command-line interaction guides through project creation and setup.

```text
>> serverless

Serverless: No project detected. Do you want to create a new one? Yes
Serverless: What do you want to make? AWS Node.js
Serverless: What do you want to call this project? histogram-api

Project successfully created in 'histogram-api' folder.

You can monitor, troubleshoot, and test your new service with a free Serverless account.

Serverless: Would you like to enable this? No
You can run the “serverless” command again if you change your mind later.

```

--------------------------------

### Setup Laravel Project

Source: https://upstash.com/docs/redis/overall/llms-txt

Commands to install the Laravel installer globally, scaffold a new project, and navigate into the project directory.

```shell
composer global require laravel/installer
laravel new example-app
cd example-app
```

--------------------------------

### Install Python Libraries

Source: https://upstash.com/docs/redis/tutorials/python_realtime_chat

Install Flask, Flask-SocketIO, and the Redis library using pip. This is the initial setup step for the project.

```bash
pip install flask flask-socketio redis
```

--------------------------------

### Initialize Serverless Project CLI

Source: https://upstash.com/docs/redis/overall/llms-txt

Use this command-line interaction to guide through project creation and setup for a new serverless project.

```text
>> serverless

Serverless: No project detected. Do you want to create a new one? Yes
Serverless: What do you want to make? AWS Node.js
Serverless: What do you want to call this project? histogram-api

Project successfully created in 'histogram-api' folder.

You can monitor, troubleshoot, and test your new service with a free Serverless account.

Serverless: Would you like to enable this? No
You can run the “serverless” command again if you change your mind later.
```

--------------------------------

### Initialize Node.js Project and Install ioredis

Source: https://upstash.com/docs/redis/overall/llms-txt

Initializes a new Node.js project and installs the 'ioredis' package. This is a common setup step for Node.js applications interacting with Redis.

```bash
npm init

npm install ioredis
```

--------------------------------

### Serverless Project Setup with npm

Source: https://upstash.com/docs/redis/overall/llms-txt

Commands to set up a new Node.js project using the Serverless Framework and install the ioredis client.

```bash
npm install -g serverless
serverless
npm init
npm install ioredis
```

--------------------------------

### Initialize Node Project and Install Session Dependencies

Source: https://upstash.com/docs/redis/overall/llms-txt

Initializes a new Node.js project and installs Express, Redis, connect-redis, and express-session. This setup is for managing user sessions with Redis.

```bash
npm init

npm install express redis connect-redis express-session
```

--------------------------------

### Serverless Project Setup with npm

Source: https://upstash.com/docs/redis/tutorials/histogram

Installs necessary packages for the histogram API project. Ensure you have Node.js and npm installed.

```bash
npm install -g serverless
```

```bash
npm init
```

```bash
npm install ioredis
```

```bash
npm install hdr-histogram-js
```

--------------------------------

### Synchronous Redis SET/GET Example

Source: https://upstash.com/docs/redis/overall/llms-txt

Example of setting and getting a key using the synchronous Redis client. Initialize the client outside the request handler in serverless environments.

```python
from upstash_redis import Redis

redis = Redis.from_env()

def main():
  redis.set("a", "b")
  print(redis.get("a"))
```

--------------------------------

### Synchronous Redis Command Example

Source: https://upstash.com/docs/redis/sdks/py/gettingstarted

Example of setting and getting a key using the synchronous Redis client. It's recommended to initialize the client outside the request handler in serverless environments.

```python
from upstash_redis import Redis

redis = Redis.from_env()

def main():
  redis.set("a", "b")
  print(redis.get("a"))
```

--------------------------------

### Asynchronous Redis Command Example

Source: https://upstash.com/docs/redis/sdks/py/gettingstarted

Example of setting and getting a key using the asynchronous Redis client. It's recommended to initialize the client outside the request handler in serverless environments.

```python
from upstash_redis.asyncio import Redis

redis = Redis.from_env()

async def main():
  await redis.set("a", "b")
  print(await redis.get("a"))
```

--------------------------------

### Basic SET Command Example

Source: https://upstash.com/docs/redis/features/restapi

Demonstrates how to set a key-value pair using a GET request with authorization header.

```APIDOC
## GET /set/foo/bar

### Description
Executes a Redis SET command to store a value associated with a key.

### Method
GET

### Endpoint
`REST_URL/set/foo/bar`

### Parameters
#### Query Parameters
- **Authorization** (string) - Required - Bearer token for authentication.

### Request Example
```shell
curl https://us1-merry-cat-32748.upstash.io/set/foo/bar \
 -H "Authorization: Bearer $TOKEN"
```

### Response
#### Success Response (200)
- **result** (string) - The result of the command, typically "OK" for SET.

#### Response Example
```json
{ "result": "OK" }
```
```

--------------------------------

### Asynchronous Redis SET/GET Example

Source: https://upstash.com/docs/redis/overall/llms-txt

Example of setting and getting a key using the asynchronous Redis client. Initialize the client outside the request handler in serverless environments.

```python
from upstash_redis.asyncio import Redis

redis = Redis.from_env()

async def main():
  await redis.set("a", "b")
  print(await redis.get("a"))
```

--------------------------------

### BITFIELD GET Command Example (Python)

Source: https://upstash.com/docs/redis/overall/llms-txt

Demonstrates retrieving values from specific offsets within a bitfield using the Python Redis client. Ensure the 'redis' library is installed.

```python
redis.set("mykey", "\x05\x06\x07")

result = redis.bitfield("mykey") \
    .get("u8", 0) \
    .get("u8", 8) \
    .get("u8", 16) \
    .execute()

# Expected result: [5, 6, 7]
```

--------------------------------

### Create Application Directory

Source: https://upstash.com/docs/redis/quickstarts/koyeb

Set up a new directory for your demo application and navigate into it.

```bash
mkdir example-koyeb-upstash
cd example-koyeb-upstash
```

--------------------------------

### GET /xread API Endpoint Example

Source: https://upstash.com/docs/redis/overall/llms-txt

Conceptual API documentation for reading data from Redis streams. Use this to retrieve messages from one or more streams starting from specified IDs.

```json
{
  "streams": {"mystream": "0-0"},
  "count": 1
}
```

--------------------------------

### Initialize Node.js Project and Install Dependencies

Source: https://upstash.com/docs/redis/tutorials/aws_app_runner_with_redis

Initialize a new Node.js project and install the 'ioredis' package for Redis interaction.

```bash
npm init

npm install ioredis
```

--------------------------------

### GET /xread API Endpoint Response Example

Source: https://upstash.com/docs/redis/overall/llms-txt

Example of a successful response from the GET /xread endpoint, showing data from streams.

```json
[
  ["mystream", [
    ["1638360173533-0", ["field1", "value1", "field2", "value2"]],
    ["1638360173533-1", ["field1", "value3", "field2", "value4"]]
  ]]
]
```

--------------------------------

### View Client Information After Setting

Source: https://upstash.com/docs/redis/sdks/py/commands/connection/client_setinfo

After setting client information using CLIENT SETINFO, you can view it using the CLIENT LIST command. This example shows the setup steps.

```python
# Set client information
redis.client_setinfo("LIB-NAME", "redis-py")
redis.client_setinfo("LIB-VER", "1.0.0")

# View all clients (if you have access to CLIENT LIST)
# The output will include lib-name and lib-ver fields
```

--------------------------------

### Redis GET Command Response Example

Source: https://upstash.com/docs/redis/overall/llms-txt

Example JSON response for the Redis GET command. It shows the retrieved value or null if the key does not exist.

```json
{
  "value": "bar"
}
```

--------------------------------

### Create Demo Application Directory and Initialize npm

Source: https://upstash.com/docs/redis/overall/llms-txt

Sets up a new project directory for a demo application and initializes a package.json file using npm. These bash commands are the first steps in creating a Node.js application.

```bash
mkdir example-koyeb-upstash
cd example-koyeb-upstash
```

```bash
npm init -y
```

--------------------------------

### GET /hvals API Example

Source: https://upstash.com/docs/redis/overall/llms-txt

Example of an HTTP GET request to retrieve all values associated with a specific hash key in Redis. The 'key' parameter is required.

```http
GET /hvals?key=myhash
```

--------------------------------

### FastAPI Application Setup

Source: https://upstash.com/docs/redis/quickstarts/fastapi

Create a FastAPI app and initialize Upstash Redis client using environment variables. This example increments a counter on each root request.

```python
from fastapi import FastAPI

from upstash_redis import Redis

app = FastAPI()

redis = Redis.from_env()

@app.get("/")
def read_root():
    count = redis.incr('counter')
    return {"count": count}
```

--------------------------------

### Initialize and Configure Serverless Project

Source: https://upstash.com/docs/redis/overall/llms-txt

Commands to scaffold a new Serverless Framework project, install necessary dependencies, and define the package configuration.

```shell
serverless
cd counter-serverless
npm install
```

--------------------------------

### Get Time to Live (PTTL) API Example

Source: https://upstash.com/docs/redis/overall/llms-txt

Example JSON payload to get the time to live for a key in milliseconds. The key is provided in the request body.

```json
{
  "key": "mykey"
}
```

--------------------------------

### Initialize Serverless Framework Project

Source: https://upstash.com/docs/redis/overall/llms-txt

Guides the user through the interactive CLI process to scaffold a new Serverless project. Follow prompts to select templates, runtimes, and name the service for AWS Node.js environments.

```text
serverless
# Follow interactive prompts to select AWS / Node.js / HTTP API template
```

--------------------------------

### Get Function Engine Stats Response Example

Source: https://upstash.com/docs/redis/overall/llms-txt

Example JSON response for the GET /functions/stats endpoint. It provides statistics on function running engines, including library and function counts.

```json
{
  "engines": {
    "LUA": {
      "librariesCount": 3,
      "functionsCount": 15
    }
  }
}
```

--------------------------------

### Get Stream Length (XLEN) API Example

Source: https://upstash.com/docs/redis/overall/llms-txt

Example HTTP GET request to retrieve the number of entries in a Redis stream using the XLEN command. The key for the stream is provided as a query parameter.

```APIDOC
## Get Stream Length (XLEN) API Example

### Description
Example HTTP GET request to retrieve the number of entries in a Redis stream using the XLEN command. The key for the stream is provided as a query parameter.

### Method
GET

### Endpoint
/websites/upstash-redis/xlen

### Query Parameters
- **key** (string) - Required - The key of the stream to get the length of.
```

--------------------------------

### Complete Client Setup

Source: https://upstash.com/docs/redis/sdks/ts/commands/connection/client_setinfo

This snippet shows how to set both the library name and version to configure client information. This information will be visible in the CLIENT LIST output.

```typescript
await redis.clientSetInfo("LIB-NAME", "my-redis-wrapper");
await redis.clientSetInfo("LIB-VER", "3.2.1");
```

--------------------------------

### FastAPI Application Setup

Source: https://upstash.com/docs/redis/overall/llms-txt

Create a FastAPI app and initialize Upstash Redis client using environment variables. This example increments a counter on each root request.

```APIDOC
## FastAPI Application Setup

### Description
Create a FastAPI app and initialize Upstash Redis client using environment variables. This example increments a counter on each root request.

### Code
```python
from fastapi import FastAPI

from upstash_redis import Redis

app = FastAPI()

redis = Redis.from_env()

@app.get("/")
def read_root():
    count = redis.incr('counter')
    return {"count": count}
```
```

--------------------------------

### Complete Client Setup

Source: https://upstash.com/docs/redis/overall/llms-txt

This snippet shows how to set both the library name and version to configure client information. This information will be visible in the CLIENT LIST output.

```APIDOC
## Complete Client Setup

### Description
This snippet shows how to set both the library name and version to configure client information. This information will be visible in the CLIENT LIST output.

### Code
```typescript
await redis.clientSetInfo("LIB-NAME", "my-redis-wrapper");
await redis.clientSetInfo("LIB-VER", "3.2.1");
```
```

--------------------------------

### Get Stream Length (XLEN) API Example

Source: https://upstash.com/docs/redis/overall/llms-txt

Example HTTP GET request to retrieve the number of entries in a Redis stream using the XLEN command. The key for the stream is provided as a query parameter.

```http
GET /websites/upstash-redis/xlen?key=mystream
```

--------------------------------

### GET /websites/upstash-redis Request Example

Source: https://upstash.com/docs/redis/overall/llms-txt

Example TypeScript request for retrieving a value by key using the Upstash Redis API.

```typescript
const value = await redis.get<MyType>("key");
```

--------------------------------

### Initialize Project and Add Sidekiq Gem

Source: https://upstash.com/docs/redis/integrations/sidekiq

Use `bundle init` to create a new Ruby project's Gemfile and `bundle add sidekiq` to include the Sidekiq gem.

```bash
bundle init 
bundle add sidekiq
```

--------------------------------

### BITFIELD Get Command Example

Source: https://upstash.com/docs/redis/sdks/py/commands/bitmap/bitfield

Demonstrates how to retrieve values from specific offsets within a bitfield using the `get` command.

```APIDOC
## BITFIELD GET

### Description
Retrieves values from a bitfield at specified offsets.

### Method
BITFIELD GET

### Endpoint
N/A (This is a command, not an HTTP endpoint)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```py
redis.set("mykey", "\x05\x06\x07")

result = redis.bitfield("mykey") \
    .get("u8", 0) \
    .get("u8", 8) \
    .get("u8", 16) \
    .execute()

# Expected result: [5, 6, 7]
```

### Response
#### Success Response (200)
- **List[int]** - Required - A list of integers, one for each `get` operation.

### Response Example
```json
{
  "example": "[5, 6, 7]"
}
```
```

--------------------------------

### Initialize Node Project and Install Dependencies

Source: https://upstash.com/docs/redis/tutorials/cloud_run_sessions

Initialize a new Node.js project and install necessary dependencies including Express, Redis, connect-redis, and express-session.

```bash
npm init

npm install express redis connect-redis express-session
```

--------------------------------

### Complete Client Library Setup with Library Name and Version

Source: https://upstash.com/docs/redis/overall/llms-txt

Demonstrates setting both the library name and version for a custom Redis wrapper using Python. This information will be visible in CLIENT LIST output.

```python
# Set both library name and version
redis.client_setinfo("LIB-NAME", "my-redis-wrapper")
redis.client_setinfo("LIB-VER", "3.2.1")

# Now this information will appear in CLIENT LIST output
```

--------------------------------

### GET /ping API Endpoint Example (TypeScript)

Source: https://upstash.com/docs/redis/overall/llms-txt

Send a ping to the server and get a response if the server is alive. This endpoint is useful for health checks.

```typescript
const response = await redis.ping();
console.log(response); // "PONG"
```

--------------------------------

### Complete Client Library Setup

Source: https://upstash.com/docs/redis/sdks/py/commands/connection/client_setinfo

This snippet demonstrates setting both the library name and version for a custom Redis wrapper. This information will be visible in CLIENT LIST output.

```python
# Set both library name and version
redis.client_setinfo("LIB-NAME", "my-redis-wrapper")
redis.client_setinfo("LIB-VER", "3.2.1")

# Now this information will appear in CLIENT LIST output
```

--------------------------------

### Get Dynamic Limit Example (JSON)

Source: https://upstash.com/docs/redis/overall/llms-txt

Example response showing the current dynamic limit if one is set. This limit overrides the default limiter settings.

```json
{
  "dynamicLimit": 5
}
```

--------------------------------

### Initialize Fastly Compute Project (JavaScript Empty Starter)

Source: https://upstash.com/docs/redis/overall/llms-txt

Initializes a new Fastly Compute@Edge project using the JavaScript empty starter template via the Fastly CLI.

```shell
> fastly compute init

Creating a new Compute@Edge project.

Press ^C at any time to quit.

Name: [fastly-upstash]
Description: 
Author: [enes@upstash.com]
Language:
[1] Rust
[2] JavaScript
[3] AssemblyScript (beta)
[4] Other ('bring your own' Wasm binary)
Choose option: [1] 2
Starter kit:
[1] Default starter for JavaScript
    A basic starter kit that demonstrates routing, simple synthetic responses and
    overriding caching rules.
    https://github.com/fastly/compute-starter-kit-javascript-default
[2] Empty starter for JavaScript
    An empty application template for the Fastly Compute@Edge environment which simply
    returns a 200 OK response.
    https://github.com/fastly/compute-starter-kit-javascript-empty
Choose option or paste git URL: [1] 2
```

--------------------------------

### LTRIM Command Example in Python

Source: https://upstash.com/docs/redis/overall/llms-txt

Trims a list so that only elements with indices between the given start and stop are kept. This example first pushes elements to a list and then trims it.

```python
redis.rpush("mylist", "one", "two", "three")
redis.ltrim("mylist", 0, 1)
```

--------------------------------

### Get Stream Length Response Example

Source: https://upstash.com/docs/redis/overall/llms-txt

This is an example JSON response for the XLEN command, indicating the number of entries in a stream. A count of 0 means the stream does not exist.

```json
{
  "count": 15
}
```

--------------------------------

### Set and View Client Information with Redis

Source: https://upstash.com/docs/redis/overall/llms-txt

After setting client information using CLIENT SETINFO, view it using the CLIENT LIST command. This example shows the setup steps.

```python
# Set client information
redis.client_setinfo("LIB-NAME", "redis-py")
redis.client_setinfo("LIB-VER", "1.0.0")

# View all clients (if you have access to CLIENT LIST)
# The output will include lib-name and lib-ver fields
```

--------------------------------

### Get Latency Histogram API Response Example

Source: https://upstash.com/docs/redis/overall/llms-txt

Example of a successful response when retrieving latency histogram data. The 'histogram' field contains bucketed performance data.

```json
{
  "testName": "perf-test-1",
  "histogram": [
    {"bucket": "0-1ms", "count": 100},
    {"bucket": "1-5ms", "count": 50},
    {"bucket": "5-10ms", "count": 10}
  ]
}
```

--------------------------------

### Setup ioredis and create search client

Source: https://upstash.com/docs/redis/search/adapters/ioredis

Initialize an ioredis client with your Upstash Redis URL and create a search client using the adapter.

```typescript
import IORedis from "ioredis";
import { createSearch, s } from "@upstash/search-ioredis";

// Create ioredis client using your Upstash Redis URL
const ioredis = new IORedis(process.env.REDIS_URL);

// Create search client
const search = createSearch(ioredis);
```

--------------------------------

### LPUSHX Command Example (Python)

Source: https://upstash.com/docs/redis/overall/llms-txt

Demonstrates pushing elements to an existing list using LPUSHX. Shows behavior when the list does not exist. Assumes a Redis client instance is available.

```python
redis.lpush("mylist", "one")

assert redis.lpushx("mylist", "two", "three") == 3

assert lrange("mylist", 0, -1) == ["three", "two", "one"]

# Non existing key
assert redis.lpushx("non-existent-list", "one") == 0
```

--------------------------------

### GET /get Serverless API Endpoint

Source: https://upstash.com/docs/redis/overall/llms-txt

Retrieves data from the Redis store using a serverless function handler. This is a basic example of a GET request to a serverless API.

```json
"Index created successfully"
```

--------------------------------

### Start Redis Instance

Source: https://upstash.com/docs/redis/overall/llms-txt

Instantly get a Redis endpoint and token by POSTing to the Upstash start endpoint. The database is temporary and expires in 72 hours unless claimed.

```APIDOC
## POST /start-redis

### Description
Initiates a new Redis database instance without requiring signup or dashboard access. The instance is temporary and expires after 72 hours.

### Method
POST

### Endpoint
`https://upstash.com/start-redis`

### Response
#### Success Response (200)
- **url** (string) - The URL of the newly created Redis endpoint.
- **token** (string) - The token for authenticating with the Redis endpoint.
```

--------------------------------

### Navigate to Project Directory

Source: https://upstash.com/docs/redis/tutorials/using_serverless_framework

Change into the newly created project directory to begin configuring your serverless application.

```shell
cd counter-serverless

```

--------------------------------

### Start Development Server

Source: https://upstash.com/docs/redis/tutorials/rate-limiting

Run this command to start a local development server for your Serverless Framework application. This allows for testing changes before deployment.

```shell
serverless dev
```

--------------------------------

### Initialize Fastly Compute Project

Source: https://upstash.com/docs/redis/quickstarts/fastlycompute

Use Fastly CLI to initialize a new Compute@Edge project. Select JavaScript and an empty starter kit for a minimal setup.

```shell
> fastly compute init

Creating a new Compute@Edge project.

Press ^C at any time to quit.

Name: [fastly-upstash]
Description:
Author: [enes@upstash.com]
Language:
[1] Rust
[2] JavaScript
[3] AssemblyScript (beta)
[4] Other ('bring your own' Wasm binary)
Choose option: [1] 2
Starter kit:
[1] Default starter for JavaScript
    A basic starter kit that demonstrates routing, simple synthetic responses and
    overriding caching rules.
    https://github.com/fastly/compute-starter-kit-javascript-default
[2] Empty starter for JavaScript
    An empty application template for the Fastly Compute@Edge environment which simply
    returns a 200 OK response.
    https://github.com/fastly/compute-starter-kit-javascript-empty
Choose option or paste git URL: [1] 2
```

--------------------------------

### Get JSON String Length with Python

Source: https://upstash.com/docs/redis/sdks/py/commands/json/strlen

Use this snippet to get the length of a JSON string stored in Redis. Ensure you have the Upstash Redis client library installed and configured.

```python
redis.json.strlen("key", "$.path.to.str")
```

--------------------------------

### Initialize Serverless Framework Project (Shell)

Source: https://upstash.com/docs/redis/overall/llms-txt

Scaffolds a new Serverless Framework project using the AWS Node.js HTTP API template. Navigates into the created directory.

```shell
serverless
cd ratelimit-serverless
```

--------------------------------

### GET Operation Response Example (JSON)

Source: https://upstash.com/docs/redis/overall/llms-txt

Describes the structure of a successful response when retrieving a value using a GET operation, indicating the previous value or None if the key did not exist.

```json
{
  "example": "b'initial_value'"
}
```

--------------------------------

### View Client Information After Setting

Source: https://upstash.com/docs/redis/sdks/ts/commands/connection/client_setinfo

After setting client information using CLIENT SETINFO, you can view it using the CLIENT LIST command. This example shows the setup and a comment indicating where to view the information.

```typescript
// Set client information
await redis.clientSetInfo("LIB-NAME", "redis-js");
await redis.clientSetInfo("LIB-VER", "1.0.0");

// View all clients (if you have access to CLIENT LIST)
// The output will include lib-name and lib-ver fields
```

--------------------------------

### Create Project Directory

Source: https://upstash.com/docs/redis/overall/llms-txt

Creates a new directory for your project and navigates into it. This is a common first step for new projects.

```bash
mkdir app_runner_example

cd app_runner_example
```

--------------------------------

### Initialize Fastly Compute Project (JavaScript Empty Starter)

Source: https://upstash.com/docs/redis/overall/llms-txt

Initializes a new Fastly Compute@Edge project using the JavaScript empty starter template via the Fastly CLI.

```APIDOC
## Initialize Fastly Compute Project (JavaScript Empty Starter)

### Description
Initializes a new Fastly Compute@Edge project using the JavaScript empty starter template via the Fastly CLI.

### Command
```shell
fastly compute init
```

### Prompts and Selections
```
Creating a new Compute@Edge project.

Press ^C at any time to quit.

Name: [fastly-upstash]
Description: 
Author: [enes@upstash.com]
Language:
[1] Rust
[2] JavaScript
[3] AssemblyScript (beta)
[4] Other ('bring your own' Wasm binary)
Choose option: [1] 2
Starter kit:
[1] Default starter for JavaScript
    A basic starter kit that demonstrates routing, simple synthetic responses and
    overriding caching rules.
    https://github.com/fastly/compute-starter-kit-javascript-default
[2] Empty starter for JavaScript
    An empty application template for the Fastly Compute@Edge environment which simply
    returns a 200 OK response.
    https://github.com/fastly/compute-starter-kit-javascript-empty
Choose option or paste git URL: [1] 2
```
```

--------------------------------

### Perform GET request with Base64 encoding (curl)

Source: https://upstash.com/docs/redis/overall/llms-txt

Example using curl to perform a GET request to Upstash Redis with Base64 encoding enabled. This is useful for handling binary data.

```APIDOC
## Perform GET request with Base64 encoding (curl)

### Description
Example using curl to perform a GET request to Upstash Redis with Base64 encoding enabled. This is useful for handling binary data.

### Method
GET

### Endpoint
`https://your-upstash-redis-url.com/GET/foo`

### Headers
- `Authorization`: `Bearer YOUR_AUTH_TOKEN`
- `Upstash-Encoding`: `base64`
```

--------------------------------

### Initialize Fastly Compute Project and Install Upstash Redis SDK

Source: https://upstash.com/docs/redis/overall/llms-txt

Initializes a new Fastly Compute project and installs the Upstash Redis SDK using the Fastly CLI and npm.

```shell
fastly compute init
npm install @upstash/redis
```

--------------------------------

### Create Application Directory

Source: https://upstash.com/docs/redis/overall/llms-txt

Set up a new directory for your demo application and navigate into it.

```APIDOC
## Create Application Directory

### Description
Set up a new directory for your demo application and navigate into it.

### Commands
```bash
mkdir example-koyeb-upstash
cd example-koyeb-upstash
```
```

--------------------------------

### SCARD - Get Set Size API Request Example

Source: https://upstash.com/docs/redis/overall/llms-txt

Shows how to get the number of elements in a set stored at a specific key using the SCARD command. The key is provided as a query parameter.

```APIDOC
## SCARD - Get Set Size API Request Example

### Description
Shows how to get the number of elements in a set stored at a specific key using the SCARD command. The key is provided as a query parameter.

### Method
GET

### Endpoint
/SCARD

### Parameters
#### Query Parameters
- **key** (string) - Required - The key of the set.

### Request Example
```bash
GET /SCARD?key=my_set
```
```

--------------------------------

### Create Project Directory

Source: https://upstash.com/docs/redis/overall/llms-txt

Creates a new directory for your project and navigates into it using standard shell commands. This is a foundational step for project setup.

```bash
mkdir cloud-run-sessions

cd cloud-run-sessions
```

--------------------------------

### SCARD - Get Set Size API Request Example

Source: https://upstash.com/docs/redis/overall/llms-txt

Shows how to get the number of elements in a set stored at a specific key using the SCARD command. The key is provided as a query parameter.

```bash
GET /SCARD?key=my_set
```

--------------------------------

### Install Project Dependencies

Source: https://upstash.com/docs/redis/tutorials/rate-limiting

Execute this command to install all the dependencies listed in the package.json file, including @upstash/ratelimit and @upstash/redis.

```shell
npm install
```

--------------------------------

### Get Substring of String Value

Source: https://upstash.com/docs/redis/overall/llms-txt

Returns a substring of the value at the specified key. The substring is a contiguous range of characters within the string, starting at the start index and ending at the end index (inclusive).

```http
GET /your-redis-endpoint/getrange
```

--------------------------------

### Start Development Server

Source: https://upstash.com/docs/redis/overall/llms-txt

Run this command to start a local development server for your Serverless Framework application. This allows for testing changes before deployment.

```APIDOC
## Start Development Server

### Description
Run this command to start a local development server for your Serverless Framework application. This allows for testing changes before deployment.

### Command
```shell
serverless dev
```
```

--------------------------------

### Trim JSON Array with JSON.ARRTRIM (Request Example)

Source: https://upstash.com/docs/redis/overall/llms-txt

Provides an example request body for trimming a JSON array at a specified path to contain only elements within the provided start and stop indices.

```json
{
  "key": "my_key",
  "path": "$.path.to.array",
  "start": 2,
  "stop": 10
}
```

--------------------------------

### Initialize Fixed Window Ratelimit in Python

Source: https://upstash.com/docs/redis/overall/llms-txt

Sets up a rate limiter using the FixedWindow algorithm. Requires importing Ratelimit, FixedWindow, and Redis. Redis configuration should be done via environment variables.

```python
from upstash_ratelimit import Ratelimit, FixedWindow
from upstash_redis import Redis

ratelimit = Ratelimit(
    redis=Redis.from_env(),
    limiter=FixedWindow(max_requests=10, window=10),
)
```

--------------------------------

### Upstash Redis Python SDK: Bitfield Get Values

Source: https://upstash.com/docs/redis/overall/llms-txt

Retrieves values from specified offsets within a bitfield. The key must exist and contain data. This example uses `bitfield` with `get` operations.

```python
redis.set("mykey", "\x05\x06\x07")

result = redis.bitfield("mykey") \
    .get("u8", 0) \
    .get("u8", 8) \
    .get("u8", 16) \
    .execute()

assert result == [5, 6, 7]
```

--------------------------------

### Install Serverless CLI and Packages

Source: https://upstash.com/docs/redis/overall/llms-txt

Installs necessary packages for a project using the Serverless Framework and npm. Ensure Node.js and npm are installed.

```bash
npm install -g serverless
```

```bash
npm init
```

```bash
npm install ioredis
```

```bash
npm install hdr-histogram-js
```

--------------------------------

### Get Set Cardinality with SCARD

Source: https://upstash.com/docs/redis/sdks/ts/commands/set/scard

Use this snippet to get the number of members in a set. Ensure the set is populated before calling SCARD. The example uses `redis.sadd` to add members and then `redis.scard` to retrieve the count.

```typescript
await redis.sadd("key", "a", "b", "c"); 
const cardinality = await redis.scard("key");
console.log(cardinality); // 3
```

--------------------------------

### Install Project Dependencies

Source: https://upstash.com/docs/redis/overall/llms-txt

Execute this command to install all the dependencies listed in the package.json file, including @upstash/ratelimit and @upstash/redis.

```APIDOC
## Install Project Dependencies

### Description
Execute this command to install all the dependencies listed in the package.json file, including @upstash/ratelimit and @upstash/redis.

### Command
```shell
npm install
```
```

--------------------------------

### GET /xread API Endpoint

Source: https://upstash.com/docs/redis/overall/llms-txt

Documentation for the `GET /xread` endpoint, which reads data from one or more Redis streams starting from specified IDs. It supports reading new messages and limiting the number of results.

```APIDOC
## GET /xread

### Description
Reads data from one or multiple streams, starting from the specified IDs. Returns messages added to the stream after the provided ID.

### Method
GET

### Endpoint
/xread

### Parameters
#### Request Body
- **streams** (Dict[str, str]) - Required - A dictionary mapping stream keys to their starting IDs. Use `$` to read only new messages.
- **count** (int) - Optional - The maximum number of messages to return per stream.

### Request Example
```json
{
  "streams": {"mystream": "0-0"},
  "count": 1
}
```

### Response
#### Success Response (200)
- **data** (List[List[Any]]) - A list where each element represents a stream containing the stream key and a list of messages (ID and field-value pairs).

#### Response Example
```json
[
  ["mystream", [
    ["1638360173533-0", ["field1", "value1", "field2", "value2"]],
    ["1638360173533-1", ["field1", "value3", "field2", "value4"]]
  ]]
]
```
```

--------------------------------

### Evaluate Lua Script (GET example)

Source: https://upstash.com/docs/redis/overall/llms-txt

Evaluates a Lua script that retrieves a key's value.

```APIDOC
## Evaluate Lua Script (GET example)

### Description
Evaluates a Lua script that retrieves a key's value.

### Method
POST

### Endpoint
/api/redis/eval

### Parameters
#### Request Body
- **script** (string) - Required - The Lua script to execute.
- **keys** (string[]) - Required - An array of keys the script needs.

### Request Example
```json
{
  "script": "local value = redis.call(\"GET\", KEYS[1])\nreturn value",
  "keys": ["mykey"]
}
```

### Response
#### Success Response (200)
- **result** (any) - The result of the script execution.

#### Response Example
```json
{
  "result": "Hello"
}
```
```

--------------------------------

### Redis HGETDEL Multiple Fields Example

Source: https://upstash.com/docs/redis/sdks/py/commands/hash/hgetdel

Shows setting session fields and then atomically getting and deleting all of them.

```python
redis.hset("session:abc", values={
    "token": "xyz123",
    "user": "john",
    "expires": "2024-12-31"
})

# Get and delete all fields
session = redis.hgetdel("session:abc", "token", "user", "expires")
assert session == ["xyz123", "john", "2024-12-31"]
```

--------------------------------

### Configure Google Cloud Project and Enable Services (Bash)

Source: https://upstash.com/docs/redis/overall/llms-txt

Shows how to configure the Google Cloud SDK using Bash commands to set the active project and enable necessary APIs for Google Cloud Run deployment.

```bash
# gcloud config set project <your-project-id>
# gcloud services enable run.googleapis.com
# gcloud services enable cloudbuild.googleapis.com
```

--------------------------------

### GET /GETRANGE

Source: https://upstash.com/docs/redis/overall/llms-txt

Retrieves a substring of the value stored at the specified key based on start and end indices.

```APIDOC
## GETRANGE

### Description
Returns a substring of the value stored at the specified key, defined by the start and end offsets.

### Method
GET

### Endpoint
/GETRANGE

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example (Code Snippet)
(Example not provided in source)

### Response
#### Success Response (200)
- **substring** (string) - The specified substring of the value.
```

--------------------------------

### Install upstash-ratelimit

Source: https://upstash.com/docs/redis/sdks/ratelimit-py/gettingstarted

Install the library using pip. This is the first step to enable rate limiting.

```bash
pip install upstash-ratelimit
```

--------------------------------

### LTRIM Command Example in Python

Source: https://upstash.com/docs/redis/overall/llms-txt

Trims a list so that only elements with indices between the given start and stop are kept.

```APIDOC
## LTRIM Command Example in Python

### Description
Trims a list so that only elements with indices between the given start and stop are kept.

### Method
`redis.ltrim(key, start, stop)`

### Endpoint
N/A (Client-side command)

### Parameters
#### Path Parameters
- **key** (str) - Required - The key of the list.
- **start** (int) - Required - The starting index.
- **stop** (int) - Required - The ending index.

### Request Example
```python
redis.rpush("mylist", "one", "two", "three")
redis.ltrim("mylist", 0, 1)
```

### Response
#### Success Response (200)
- **bool** - Returns True if the trim operation was successful.
```

--------------------------------

### Initialize SST Project and Dependencies

Source: https://upstash.com/docs/redis/overall/llms-txt

Scaffold a new SST Next.js application and install the necessary Upstash Redis client package.

```shell
npx create-sst@latest --template standard/nextjs
```

```shell
cd my-sst-app
```

```shell
npm install
```

```shell
npm install @upstash/redis
```

--------------------------------

### Initialize Koyeb App with Git and Environment Variables

Source: https://upstash.com/docs/redis/quickstarts/koyeb

Use this command to initialize a new Koyeb application from a GitHub repository, configuring ports, routes, and essential environment variables for Upstash Redis.

```bash
koyeb app init example-koyeb-upstash \
  --git github.com/<YOUR_GITHUB_USERNAME>/<YOUR_REPOSITORY_NAME> \
  --git-branch main \
  --ports 3000:http \
  --routes /:3000 \
  --env PORT=3000 \
  --env UPSTASH_REDIS_REST_URL="<YOUR_UPSTASH_REDIS_REST_URL>" \
  --env UPSTASH_REDIS_REST_TOKEN="<YOUR_UPSTASH_REDIS_REST_TOKEN>"
```

--------------------------------

### GET /randomkey Endpoint

Source: https://upstash.com/docs/redis/overall/llms-txt

Fetches a random key from the Upstash Redis database. This is a direct HTTP API example.

```APIDOC
## MGET Command Example (TypeScript)

### Description
Retrieves the values associated with multiple keys from Redis using the `mget` command in TypeScript. It assumes a configured Redis client instance.

### Method
MGET

### Endpoint
(Not applicable for SDK method)

### Parameters
#### Path Parameters
- **keys** (Array<string>) - Required - The keys whose values are to be retrieved.

### Request Example
```typescript
// Assuming 'redis' is a configured Redis client instance
const values = await redis.mget("key1", "key2", "key3");
```

### Response
#### Success Response (200)
- **values** (Array<any>) - An array containing the values of the keys requested, in the same order as the keys.
```
```

--------------------------------

### Navigate to Project Directory

Source: https://upstash.com/docs/redis/tutorials/rate-limiting

Change the current directory to the newly created Serverless Framework project.

```shell
cd ratelimit-serverless
```

--------------------------------

### Install Serverless Framework

Source: https://upstash.com/docs/redis/tutorials/serverless_java_redis

Installs the Serverless Framework globally. Ensure you have Node.js and npm installed.

```shell
npm i serverless@3.39.0 -g
```

--------------------------------

### Get Key Expiration in Milliseconds with PTTL

Source: https://upstash.com/docs/redis/sdks/py/commands/generic/pttl

Use the PTTL command to get the expiration time of a key in milliseconds. This example demonstrates setting a key, checking its PTTL, setting an expiration, checking again, and then persisting the key to remove its expiration.

```python
redis.set("key1", "Hello")

assert redis.pttl("key1") == -1

redis.expire("key1", 1000)

assert redis.pttl("key1") > 0

redis.persist("key1")

assert redis.pttl("key1") == -1
```

--------------------------------

### Create Django Project and App (Shell)

Source: https://upstash.com/docs/redis/overall/llms-txt

Commands to set up a new Django project and application. Use `django-admin startproject` to create the project and `python manage.py startapp` to generate the app structure within the project.

```shell
django-admin startproject myproject
cd myproject
python manage.py startapp myapp
```