Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 1.49 KB

README.md

File metadata and controls

55 lines (39 loc) · 1.49 KB

Upstash QStash CLI

npm (scoped)

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.

QStash CLI is a command-line tool that helps developers work with QStash locally. The only command currently available is dev, which runs a local QStash server for development and testing purposes.

QStash is an HTTP based messaging and scheduling solution for serverless and edge runtimes.

It is 100% built on stateless HTTP requests and designed for:

  • Serverless functions (AWS Lambda ...)
  • Cloudflare Workers (see the example)
  • Fastly Compute@Edge
  • Next.js, including edge
  • Deno
  • Client side web/mobile applications
  • WebAssembly
  • and other environments where HTTP is preferred over TCP.

Quick Start

Install

npm install @upstash/qstash-cli

Basic Usage:

npx @upstash/qstash-cli dev

Available Commands

Usage:
        qstash-cli [command] [options]
Commands:
        dev     Start a local dev server
Options:
        -port  The port number to start server on (default: 8080)

Docs

See the local development guide for details.