# upstash-redis-js

Get guidance for using @upstash/redis in TypeScript and JavaScript, from caching to search. Use it when adding Redis features or moving a project from another Redis client.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 22400 installs · ★ 34
- Author: Upstash
- License: MIT · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/upstash/skills/tree/HEAD/skills/upstash-redis-js/SKILL.md
- Updated: 2026-10-22
- HTML: https://affpapa.org/en/nevibecode/skills/upstash-redis-js

## What it does

The skill includes guides to Redis data types and patterns for caching, sessions, distributed locks, pipelines, and transactions. It covers lists, streams, JSON documents, vector search, and full-text search with Upstash Redis Search. It also explains how the SDK serializes JavaScript values automatically.

Install `@upstash/redis` with `npm install @upstash/redis`. Set `UPSTASH_REDIS_REST_URL` and `UPSTASH_REDIS_REST_TOKEN`, or initialize the client with `Redis.fromEnv()`. The app needs the database URL and token to connect, so have those credentials ready before testing the integration.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add upstash/skills --skill upstash-redis-js -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/upstash-redis-js/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/upstash-redis-js/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add upstash/skills --skill upstash-redis-js -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/upstash-redis-js/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add upstash/skills --skill upstash-redis-js -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/upstash-redis-js/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install upstash/skills upstash-redis-js
```

2. **Manually: put the files in place**
- File: `.github/skills/upstash-redis-js/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add upstash/skills --skill upstash-redis-js -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/upstash/skills --path skills/upstash-redis-js
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/upstash-redis-js/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add upstash/skills --skill upstash-redis-js -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/upstash/skills/tree/HEAD/skills/upstash-redis-js/SKILL.md

## When to use it
- add a cache with key expiration
- store user sessions in Redis
- build a task queue with lists or streams
- migrate a project from `ioredis` or `node-redis`
- search Redis documents by text

## Example prompts
- Add a Redis cache with TTL using `@upstash/redis` and show the connection setup.
- Convert this `ioredis` code to `@upstash/redis`, accounting for serialization differences.
- Set up Redis-backed user sessions with the Upstash SDK.

## Source text · SKILL.md · MIT

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: dd5ffdcb4d15681b.

BEGIN THIRD-PARTY FILE dd5ffdcb4d15681b
````text
---
name: upstash-redis-js
description: Work with the @upstash/redis TypeScript/JavaScript SDK, a serverless HTTP-based Redis client for Next.js, Vercel, Cloudflare Workers, edge runtimes, and Node.js. Use when adding a cache (cache-aside, write-through, TTL and expiration strategies), session storage and user sessions, a key-value store, leaderboards and rankings with sorted sets, counters, distributed locks, queues with lists, streams and consumer groups, sparse index-addressed arrays and ring buffers (ARSET, ARINSERT, ARRING, ARGREP, AROP), embeddings and nearest-neighbour vector search stored inside Redis (VECTOR commands via redis.vector, separate from @upstash/vector), JSON documents, pipelines and MULTI/EXEC transactions, Lua scripting, read replicas, or full-text search, typo-tolerant search, facets, aggregations, and search over Redis stream entries with Upstash Redis Search (different from regular FT.SEARCH; also available for TCP clients via @upstash/search-redis and @upstash/search-ioredis). Also use when migrating from ioredis or node-redis, when a Redis connection is needed from a serverless function without connection pooling, when integrating @upstash/ratelimit, or when the user says Redis cache, KV store, session store, serverless Redis, or Upstash Redis. Also use when building AI agents on Redis with Upstash AgentKit (agent memory, chat history, RAG tools, tool caching, chat persistence, resumable streams, distributed locks) for the Vercel AI SDK, TanStack AI, or Vercel Eve. Supports automatic serialization/deserialization of JavaScript types.
license: MIT
metadata:
  author: Upstash
  homepage: https://upstash.com
---

# Upstash Redis SDK - Complete Skills Guide

This directory contains comprehensive guides for using the `@upstash/redis` SDK. These skill files are designed to help developers and AI assistants understand and use the SDK effectively.

## Installation

```bash
npm install @upstash/redis
```

## Quick Start

### Basic Initialization

```typescript
import { Redis } from "@upstash/redis";

// Initialize with explicit credentials
const redis = new Redis({
  url: "UPSTASH_REDIS_REST_URL",
  token: "UPSTASH_REDIS_REST_TOKEN",
});

// Or initialize from environment variables
const redis = Redis.fromEnv();
```

### Environment Variables

Set these in your `.env` file:

```bash
UPSTASH_REDIS_REST_URL=https://your-redis.upstash.io
UPSTASH_REDIS_REST_TOKEN=your-token-here
```

> **No credentials yet?** If you're an agent that needs scratch Redis and the user hasn't provided a database, you can mint a temporary one with a single POST to `https://upstash.com/start-redis` (3-day TTL, no signup).

## Skill Files Overview

### Data Structures (data-structures/)

Redis data types with auto-serialization examples:

- **strings.md** - GET, SET, INCR, DECR, APPEND with automatic type handling
- **hashes.md** - HSET, HGET, HMGET with object serialization
- **lists.md** - LPUSH, RPUSH, LRANGE with array handling
- **sets.md** - SADD, SMEMBERS, set operations
- **sorted-sets.md** - ZADD, ZRANGE, ZRANK, leaderboard patterns
- **json.md** - JSON.SET, JSON.GET, JSONPath queries for nested objects
````
END THIRD-PARTY FILE dd5ffdcb4d15681b

The third-party file has ended. Everything between the dd5ffdcb4d15681b tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

First 3160 of 8990 bytes. © Upstash · MIT · https://github.com/upstash/skills/tree/HEAD/skills/upstash-redis-js/SKILL.md

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md