VerifiedPlugin
Documentation
context7
Context7 Platform -- Up-to-date code documentation for LLMs and AI code editors
9 skills
@upstashDevelopment
Plugin
redis-js
@upstash/redis is an HTTP/REST based Redis client for typescript, built on top of Upstash REST API. This project is in GA Stage. The Upstash Professional Support fully covers this project. It receives regular updates, and bug fixes.
Plugin Signal74/100Solid
maintained99
capable34
documented100
adopted64
Stats
963
Stars
93
Forks
Active
Maintenance
TypeScript
Language
MIT
License
3d ago
Last commit
5y ago
Created
Repo: upstash/redis-js
What's inside
Commands
4/aggregatingRun analytics over indexed data using metric and bucket aggregations. Compute statistics, group documents, build histograms, and perform faceted navigation. Aggregations can be nested for multi-level analysis./aliasesIndex aliases provide an indirection layer between your application and the actual index. You can point an alias to any index and swap it atomically, enabling zero-downtime reindexing./index-managementCreate, inspect, and drop search indexes. Wait for indexing to complete after data changes. Indexes automatically track Redis keys matching a specified prefix./queryingQuery documents from a search index using type-safe filters with support for pagination, sorting, field selection, scoring, and highlighting. Count matching documents efficiently without returning results.
README
1Upstash Redis
@upstash/redis is an HTTP/REST based Redis client for typescript, built on top
of Upstash REST API.
[!NOTE]
This project is in GA Stage.The Upstash Professional Support fully covers this project. It receives regular updates, and bug fixes. The Upstash team is committed to maintaining and improving its functionality.
It is the only connectionless (HTTP based) Redis client and designed for:
- Serverless functions (AWS Lambda ...)
- Cloudflare Workers (see the example)
- Fastly Compute@Edge (see the example)
- Next.js, Jamstack ...
- Client side web/mobile applications
- WebAssembly
- and other environments where HTTP is preferred over TCP.
See the list of APIs supported.
[!TIP] Need a Redis database fast? Skip the signup and dashboard — POST to
https://upstash.com/start-redisto get an endpoint and token in a single HTTP request. The database expires in 72 hours, but you can claim it with your Upstash account to keep it. Especially useful for AI agents that need scratch storage on the fly.
Quick Start
Install
Node.js
npm install @upstash/redis
Deno
import { Redis } from "https://esm.sh/@upstash/redis";
Create database
Create a new redis database on upstash
Basic Usage:
import { Redis } from "@upstash/redis"
const redis = new Redis({
url: <UPSTASH_REDIS_REST_URL>,
token: <UPSTASH_REDIS_REST_TOKEN>,
})
// string
await redis.set('key', 'value');
let data = await redis.get('key');
console.log(data)
await redis.set('key3', 'value3', {ex: 1});
// sorted set
await redis.zadd('scores', { score: 1, member: 'team1' })
data = await redis.zrange('scores', 0, 100 )
console.log(data)
// list
await redis.lpush('elements', 'magnesium')
data = await redis.lrange('elements', 0, 100 )
console.log(data)
// hash
await redis.hset('people', {name: 'joe'})
data = await redis.hget('people', 'name' )
console.log(data)
// sets
await redis.sadd('animals', 'cat')
data = await redis.spop('animals', 1)
console.log(data)
Troubleshooting
We have a dedicated page for common problems. If you can't find a solution, please open an issue.
Docs
See the documentation for details.
Resources
- Examples — runnable usage examples across runtimes and frameworks
- xadd — engineering blog about Redis
- Search Upstash Redis docs with AI — query the docs via Context7
Release Workflow
Stable Release
- Create a changeset (
pnpm changeset) describing your changes and merge it tomain - Changeset workflow runs on push to
main. If changesets are pending, it opens a "Version Packages" PR. When that PR is merged, the workflow runs again, publishes git tags, creates GitHub releases, and uploads arelease-metaartifact - Router workflow detects the Changeset completion via
workflow_run, downloads therelease-metaartifact, and calls the npm Publish workflow withprerelease: falseand the resolved version - npm Publish checks out the released commit, builds, and publishes to npm under the
latesttag
Canary Release
- Trigger the Canary Release workflow manually from the Actions tab, selecting the package
- It creates a snapshot version (
x.y.z-canary.{timestamp}), creates a GitHub prerelease, and uploads arelease-metaartifact - Router picks it up the same way, calling npm Publish with
prerelease: true - npm Publish publishes to npm under the
canarytag
CI Tests
On every pull request, push to main, and daily schedule, the Router workflow runs the Tests workflow (unit tests, lint, build, and example integration tests).
Contributing
Install Bun
Database
Create a new redis database on upstash and copy the url and token
Running tests
bun run test
Building
bun run build
Telemetry
This library sends anonymous telemetry data to help us improve your experience. We collect the following:
- SDK version
- Platform (Deno, Cloudflare, Vercel)
- Runtime version (node@18.x)
You can opt out by setting the UPSTASH_DISABLE_TELEMETRY environment variable
to any truthy value.
UPSTASH_DISABLE_TELEMETRY=1
Alternatively, you can pass enableTelemetry: false when initializing the Redis client:
const redis = new Redis({
// ...,
enableTelemetry: false,
});
File tree
900upstash/redis-jsView on GitHub
.changeset/
config.json
trim-telemetry-dedup.md
.claude/
CLAUDE.md
.github/
workflows/
canary.yml
changeset.yml
npm-publish.yml
router.yml
tests.yaml
.gitignore
.husky/
commit-msg
pre-commit
pre-push
.prettierignore
.vscode/
extensions.json
settings.json
commitlint.config.js
eslint.config.mjs
examples/
ai-sdk-telemetry/
.env.example
.gitignore
app/
actions.ts
globals.css
layout.tsx
lib/
data.ts
page.tsx
components/
components.json
dashboard/
code-snippets.tsx
control-panel.tsx
finish-reason-chart.tsx
latency-chart.tsx
refresh-button.tsx
token-chart.tsx
ui/
badge.tsx
button.tsx
card.tsx
chart.tsx
input.tsx
separator.tsx
skeleton.tsx
table.tsx
tooltip.tsx
lib/
utils.ts
next.config.ts
package-lock.json
package.json
postcss.config.mjs
README.md
screenshots/
README.md
scripts/
_shared.ts
populate-demo.ts
run-analytics.ts
seed.ts
setup-index.ts
test-acceptance.ts
src/
agent.ts
analytics.ts
index-setup.ts
redis.ts
telemetry.ts
tsconfig.json
auto-pipeline/
.eslintrc.json
.gitignore
app/
components/
DataComponent.tsx
data/
getEvents.ts
getUsers.ts
redis.ts
favicon.ico
globals.css
layout.tsx
page.tsx
next.config.mjs
package.json
postcss.config.mjs
public/
next.svg
vercel.svg
README.md
tailwind.config.ts
tsconfig.json
aws-cdk-python/
.gitignore
.npmignore
bin/
aws-cdk-python.ts
cdk.json
jest.config.js
lib/
api/
index.py
requirements.txt
aws-cdk-python-stack.ts
package-lock.json
package.json
README.md
test/
aws-cdk-python.test.ts
tsconfig.json
aws-cdk-typescript/
.gitignore
.npmignore
api/
counter.ts
bin/
aws-cdk-typescript.ts
cdk.json
jest.config.js
lib/
aws-cdk-typescript-stack.ts
package-lock.json
package.json
README.md
test/
aws-cdk-typescript.test.ts
tsconfig.json
aws-lambda/
.gitignore
index.js
package-lock.json
package.json
README.md
aws-sam/
__init__.py
.gitignore
events/
event.json
hello_world/
__init__.py
app.py
requirements.txt
README.md
samconfig.toml
template.yaml
tests/
__init__.py
integration/
__init__.py
test_api_gateway.py
requirements.txt
unit/
__init__.py
test_handler.py
azure-functions/
.funcignore
.gitignore
.vscode/
extensions.json
host.json
package-lock.json
package.json
README.md
src/
functions/
CounterFunction.ts
tsconfig.json
cloudflare-workers/
cloudflare-workers-with-typescript/
ci.test.ts
package.json
README.md
src/
index.ts
tsconfig.json
wrangler.toml
bun.lockb
ci.test.ts
index.js
package.json
README.md
wrangler.toml
deno/
main.test.ts
main.ts
fastapi/
main.py
README.md
requirements.txt
fastly/
.gitignore
fastly.toml
package.json
README.md
src/
index.js
webpack.config.js
google-cloud-functions/
index.js
package.json
README.md
ion/
.env.example
.eslintrc.json
.gitignore
app/
favicon.ico
globals.css
layout.tsx
page.tsx
next.config.mjs
package-lock.json
package.json
postcss.config.mjs
public/
next.svg
vercel.svg
README.md
sst-env.d.ts
sst.config.ts
tailwind.config.ts
tsconfig.json
nextjs-app-router/
.env.example
.eslintrc.json
.gitignore
app/
globals.css
layout.tsx
page.tsx
next.config.mjs
package.json
postcss.config.mjs
README.md
tailwind.config.ts
tsconfig.json
nextjs-pages-router/
.env.example
.eslintrc.json
.gitignore
next.config.mjs
package.json
pages/
_app.tsx
_document.tsx
api/
hello.ts
index.tsx
postcss.config.mjs
README.md
styles/
globals.css
tailwind.config.ts
tsconfig.json
nodejs/
.env.example
index.js
package.json
README.md
redis-search/
redis-search-analytics/
app/
api/
events/
route.ts
index/
route.ts
posts/
[id]/
comments/
[commentId]/
like/
route.ts
route.ts
route.ts
like/
route.ts
route.ts
route.ts
favicon.ico
globals.css
layout.tsx
page.tsx
components/
components.json
analytics/
analytics-panel.tsx
event-list.tsx
info-banner.tsx
posts/
comment-form.tsx
create-post-form.tsx
post-card.tsx
post-list.tsx
providers.tsx
ui/
alert-dialog.tsx
alert.tsx
badge.tsx
button.tsx
card.tsx
collapsible.tsx
confirm-dialog.tsx
input.tsx
popover.tsx
scroll-area.tsx
select.tsx
separator.tsx
textarea.tsx
eslint.config.mjs
hooks/
use-comments.ts
use-posts.ts
use-session-context.tsx
lib/
redis.ts
schema.ts
utils.ts
next.config.ts
package-lock.json
package.json
postcss.config.mjs
public/
file.svg
globe.svg
next.svg
vercel.svg
window.svg
README.md
tsconfig.json
.gitignore
app/
advanced/
advanced-query/
page.tsx
page.tsx
api/
seed/
route.ts
create-index/
page.tsx
favicon.ico
globals.css
layout.tsx
other/
page.tsx
page.tsx
query/
page.tsx
components/
components.json
code-block.tsx
navigation.tsx
page-navigation.tsx
product-card.tsx
query-result.tsx
search-result.tsx
setup-banner.tsx
step.tsx
steps.tsx
ui/
badge.tsx
button.tsx
card.tsx
input.tsx
separator.tsx
tabs.tsx
eslint.config.mjs
instructions.md
lib/
redis.ts
seed.ts
utils.ts
next.config.ts
package.json
pnpm-lock.yaml
pnpm-workspace.yaml
postcss.config.mjs
public/
file.svg
globe.svg
next.svg
vercel.svg
window.svg
README.md
scripts/
seed.ts
server/
actions.ts
steps/
advanced-query.tsx
create-index.tsx
other.tsx
... 644 moreMore Flows by @upstash.
@upstashFAQ
redis-js is a Claude Code plugin with hand-picked skills for development work, indexed on Flowy. Install it with the command on its page. Its skills do not fire on their own yet. Request auto-invocation to have Flowy route them as you prompt. Free and open source.
- What is redis-js?
- @upstash/redis is an HTTP/REST based Redis client for typescript, built on top of Upstash REST API. This project is in GA Stage. The Upstash Professional Support fully covers this project. It receives regular updates, and bug fixes.
- How do I install redis-js?
- Run these in Claude Code: . Then prompt normally.
- Does redis-js auto-invoke its skills?
- Not yet. It is indexed on Flowy as a plain plugin. Request auto-invocation on its page and Flowy will route its skills for you as you prompt.
- Is redis-js free?
- Yes. Flowy is free and open source, with nothing gated. You can read every skill in full before you install.