Skip to main content
Upstash is a fully managed Redis database as a service. Upstash works with the Redis® API, which means you can use Bun’s native Redis client to connect to your Upstash database.
TLS is enabled by default for all Upstash Redis databases.
1

Create a new project

Create a new project by running bun init:
terminal
bun init bun-upstash-redis
cd bun-upstash-redis
2

Create an Upstash Redis database

Go to the Upstash dashboard and create a new Redis database. After completing the getting started guide, you’ll see your database page with connection information.The database page displays two connection methods; HTTP and TLS. For Bun’s Redis client, you need the TLS connection details. This URL starts with rediss://.
Upstash Redis database page
3

Connect using Bun's Redis client

You can connect to Upstash by setting environment variables with Bun’s default redis client.Set the REDIS_URL environment variable in your .env file using the Redis endpoint (not the REST URL):
.env
REDIS_URL=rediss://********@********.upstash.io:6379
Bun’s Redis client reads connection information from REDIS_URL by default:
https://mintcdn.com/bun-1dd33a4e/Hq64iapoQXHbYMEN/icons/typescript.svg?fit=max&auto=format&n=Hq64iapoQXHbYMEN&q=85&s=c6cceedec8f82d2cc803d7c6ec82b240index.ts
import { redis } from "bun";

// Reads from process.env.REDIS_URL automatically
await redis.set("counter", "0");
Alternatively, you can create a custom client using RedisClient:
https://mintcdn.com/bun-1dd33a4e/Hq64iapoQXHbYMEN/icons/typescript.svg?fit=max&auto=format&n=Hq64iapoQXHbYMEN&q=85&s=c6cceedec8f82d2cc803d7c6ec82b240index.ts
import { RedisClient } from "bun";

const redis = new RedisClient(process.env.REDIS_URL);
4

Use the Redis client

You can now use the Redis client to interact with your Upstash Redis database:
https://mintcdn.com/bun-1dd33a4e/Hq64iapoQXHbYMEN/icons/typescript.svg?fit=max&auto=format&n=Hq64iapoQXHbYMEN&q=85&s=c6cceedec8f82d2cc803d7c6ec82b240index.ts
import { redis } from "bun";

// Get a value
let counter = await redis.get("counter");

// Set a value if it doesn't exist
if (!counter) {
	await redis.set("counter", "0");
}

// Increment the counter
await redis.incr("counter");

// Get the updated value
counter = await redis.get("counter");
console.log(counter);

1
The Redis client automatically handles connections in the background. No need to manually connect or disconnect for basic operations.