Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.restate.dev/llms.txt

Use this file to discover all available pages before exploring further.

Here you can find useful links for each Restate application component: the Restate Server, CLI, SDKs, and other tools.

​
Restate Server

The Restate Server is the central component of any Restate deployment, and manages all service invocations, executions, recovery, communication, and state.

Open source (self-host)

Docs • GitHub • Docker Hub • npmSelf-contained binary under BSL-license.Homebrew:
brew install restatedev/tap/restate-server
npx:
npx @restatedev/restate-server
Binaries:
OS/Archx64arm64
Linux⬇️ Download⬇️ Download
MacOS⬇️ Download⬇️ Download

Restate Cloud

The zero-infrastructure option.

Learn more

Get a fully serverless Restate experience, managed by the developers of the system. Sign in, generate keys, point your app, go!

​
SDKs

All SDKs are open-sourced under the MIT license.
https://mintcdn.com/restate-6d46e1dc/wqMagUnGKV-8jxGV/img/languages/typescript.svg?fit=max&auto=format&n=wqMagUnGKV-8jxGV&q=85&s=bd4aec3bac5e0e4a992aac5cfbd8a31c

TypeScript / JavaScript

Docs • GitHub • npm • Examples • Quickstart
https://mintcdn.com/restate-6d46e1dc/wqMagUnGKV-8jxGV/img/languages/java.svg?fit=max&auto=format&n=wqMagUnGKV-8jxGV&q=85&s=3086c38cf505b0531e82dca3b85f2874

Java

Docs • GitHub • Maven • Examples • Quickstart
https://mintcdn.com/restate-6d46e1dc/wqMagUnGKV-8jxGV/img/languages/kotlin.svg?fit=max&auto=format&n=wqMagUnGKV-8jxGV&q=85&s=e1c79b8a40fd0583b59c09306be9bf1b

Kotlin

Docs • GitHub • Maven • Examples • Quickstart
https://mintcdn.com/restate-6d46e1dc/wqMagUnGKV-8jxGV/img/languages/go.svg?fit=max&auto=format&n=wqMagUnGKV-8jxGV&q=85&s=bd321a102bddee6f4d51cd3b9d8d662d

Go

Docs • GitHub • pkg.go • Examples • Quickstart
https://mintcdn.com/restate-6d46e1dc/wqMagUnGKV-8jxGV/img/languages/python.svg?fit=max&auto=format&n=wqMagUnGKV-8jxGV&q=85&s=25e795654858f5f5f8a1940a44a5f3ef

Python

Docs • GitHub • PyPI • Examples • Quickstart
https://mintcdn.com/restate-6d46e1dc/wqMagUnGKV-8jxGV/img/languages/rust.svg?fit=max&auto=format&n=wqMagUnGKV-8jxGV&q=85&s=d615a1791f411056323ad1d85a79f0e0

Rust

Docs • GitHub • crates.io • Examples • Quickstart

​
Tools

Restate CLI

Docs • GitHub • npmCentral management tool that lets you bootstrap new applications, register/upgrade services, debug running invocations, etc.Homebrew:
brew install restatedev/tap/restate
npm:
npm install --global @restatedev/restate
Binaries:
OS / Archx64arm64
Linux⬇️ Download⬇️ Download
MacOS⬇️ Download⬇️ Download

restatectl

Docs • GitHub • npmCluster management tool that lets you provision, control and introspect your cluster and its nodes.Homebrew:
brew install restatedev/tap/restatectl
npm:
npm install --global @restatedev/restatectl
Binaries:
OS / Archx64arm64
Linux⬇️ Download⬇️ Download
MacOS⬇️ Download⬇️ Download