Quickstart

This guide takes you through your first steps with Restate.

TypeScript

Prerequisites

• TypeScript: Latest stable version of NodeJS >= v18.17.1 and npm CLI >= 9.6.7
• Install the Restate Server & CLI

1

Get the Greeter service template

Download the Node template with a skeleton of a Restate service. And install its dependencies:

npx -y @restatedev/create-app@latest && cd restate-node-template && \

npm install

2

Run the Greeter service

Now, start developing your service in src/app.ts. Run it with ts-node-dev, and let it listen on port 9080 for requests:

npm run app-dev

3

Launch Restate

Restate is a single self-contained binary. No external dependencies needed. Once you have installed the Restate Server, run it locally via:

restate-server

4

Register the service

Tell Restate where the service is running, so Restate can discover and register the services and handlers behind this endpoint:

CLI

curl

restate deployments register http://localhost:9080

If you run Restate with Docker, use http://host.docker.internal:9080 instead of http://localhost:9080.

Output

❯ SERVICES THAT WILL BE ADDED:

- Greeter

Type: Service

HANDLER INPUT OUTPUT

greet value of content-type 'application/json' value of content-type 'application/json'

✔ Are you sure you want to apply those changes? · yes

✅ DEPLOYMENT:

SERVICE REV

Greeter 1

5

Send a request to the Greeter service

curl localhost:8080/Greeter/greet -H 'content-type: application/json' -d '"Hi"'

You should now see printed as response: Hi!

🎉

Congratulations, you managed to run your first Restate service!

Next: Build and run the app

Once you have implemented your service, build the app and run it with:

npm run build

npm run app

Java

Prerequisites

• Java: JDK >= 11
• Install the Restate Server & CLI

1

Get the Greeter service template

CLI

wget

restate example java-hello-world-gradle &&

cd java-hello-world-gradle

2

Run the Greeter service

You are all set to start developing your service. Open the project in an IDE and configure it to build with Gradle. Run your service and let it listen on port 9080 for requests:

./gradlew run

3

Launch Restate

Restate is a single self-contained binary. No external dependencies needed. Once you have installed the Restate Server, run it locally via:

restate-server

4

Register the service

Tell Restate where the service is running, so Restate can discover and register the services and handlers behind this endpoint:

CLI

curl

restate deployments register http://localhost:9080

If you run Restate with Docker, use http://host.docker.internal:9080 instead of http://localhost:9080.

Output

❯ SERVICES THAT WILL BE ADDED:

- Greeter

Type: Service

HANDLER INPUT OUTPUT

greet value of content-type 'application/json' value of content-type 'application/json'

✔ Are you sure you want to apply those changes? · yes

✅ DEPLOYMENT:

SERVICE REV

Greeter 1

5

Send a request to the Greeter service

curl localhost:8080/Greeter/greet -H 'content-type: application/json' -d '"Hi!"'

You should now see printed as response: Hi!

🎉

Congratulations, you managed to run your first Restate service!

Next: Build the app

Once you have implemented your service, build the app with:

./gradlew build

Kotlin

Prerequisites

• Java/Kotlin: JDK >= 11
• Install the Restate Server & CLI

1

Get the Greeter service template

CLI

wget

restate example kotlin-hello-world-gradle &&

cd kotlin-hello-world-gradle

2

Run the Greeter service

You are all set to start developing your service. Open the project in an IDE and configure it to build with Gradle. Run your service and let it listen on port 9080 for requests:

./gradlew run

3

Launch Restate

Restate is a single self-contained binary. No external dependencies needed. Once you have installed the Restate Server, run it locally via:

restate-server

4

Register the service

Tell Restate where the service is running, so Restate can discover and register the services and handlers behind this endpoint:

CLI

curl

restate deployments register http://localhost:9080

If you run Restate with Docker, use http://host.docker.internal:9080 instead of http://localhost:9080.

Output

❯ SERVICES THAT WILL BE ADDED:

- Greeter

Type: Service

HANDLER INPUT OUTPUT

greet value of content-type 'application/json' value of content-type 'application/json'

✔ Are you sure you want to apply those changes? · yes

✅ DEPLOYMENT:

SERVICE REV

Greeter 1

5

Send a request to the Greeter service

curl localhost:8080/Greeter/greet -H 'content-type: application/json' -d '"Hi"'

You should now see printed as response: Hi!

🎉

Congratulations, you managed to run your first Restate service!

Next: Build the app

Once you have implemented your service, build the app with:

./gradlew build

Go

Prerequisites

• Go: >= 1.21.0
• Install the Restate Server & CLI

1

Get the Greeter service template

CLI

wget

restate example go-hello-world &&

cd go-hello-world

2

Run the Greeter service

Now, start developing your service in greeter.go. Run it with:

go run .

it will listen on port 9080 for requests.

3

Launch Restate

Restate is a single self-contained binary. No external dependencies needed. Once you have installed the Restate Server, run it locally via:

restate-server

4

Register the service

Tell Restate where the service is running, so Restate can discover and register the services and handlers behind this endpoint:

CLI

curl

restate deployments register http://localhost:9080

If you run Restate with Docker, use http://host.docker.internal:9080 instead of http://localhost:9080.

Output

❯ SERVICES THAT WILL BE ADDED:

- Greeter

Type: Service

HANDLER INPUT OUTPUT

Greet value of content-type 'application/json' value of content-type 'application/json'

✔ Are you sure you want to apply those changes? · yes

✅ DEPLOYMENT:

SERVICE REV

Greeter 1

5

Send a request to the Greeter service

curl localhost:8080/Greeter/Greet -H 'content-type: application/json' -d '"Hi"'

You should now see printed as response: Hi!

🎉

Congratulations, you managed to run your first Restate service!

Next: Build and run the app

Once you have implemented your service, build the app with:

go build .

Python

Prerequisites

• Python >= v3.11
• Install the Restate Server & CLI

1

Get the Greeter service template

CLI

wget

restate example python-hello-world &&

cd python-hello-world

2

Run the Greeter service

Create a venv and install the requirements:

python3 -m venv .venv

source .venv/bin/activate

pip install -r requirements.txt

Now, start developing your service in example.py. Run it with a Hypercorn server, and let it listen on port 9080 for requests:

python -m hypercorn --config hypercorn-config.toml example:app

3

Launch Restate

Restate is a single self-contained binary. No external dependencies needed. Once you have installed the Restate Server, run it locally via:

restate-server

4

Register the service

Tell Restate where the service is running, so Restate can discover and register the services and handlers behind this endpoint:

CLI

curl

restate deployments register http://localhost:9080

If you run Restate with Docker, use http://host.docker.internal:9080 instead of http://localhost:9080.

Output

❯ SERVICES THAT WILL BE ADDED:

- Greeter

Type: Service

HANDLER INPUT OUTPUT

greet value of content-type 'application/json' value of content-type 'application/json'

✔ Are you sure you want to apply those changes? · yes

✅ DEPLOYMENT:

SERVICE REV

Greeter 1

5

Send a request to the Greeter service

curl localhost:8080/Greeter/greet -H 'content-type: application/json' -d '"Hi"'

You should now see printed as response: Hi!

🎉

Congratulations, you managed to run your first Restate service!

Rust

Prerequisites

• Rust
• Install the Restate Server & CLI

1

Get the Greeter service template

CLI

wget

restate example rust-hello-world &&

cd rust-hello-world

2

Run the Greeter service

Use cargo run to build and run the example:

cargo run

3

Launch Restate

Restate is a single self-contained binary. No external dependencies needed. Once you have installed the Restate Server, run it locally via:

restate-server

4

Register the service

Tell Restate where the service is running, so Restate can discover and register the services and handlers behind this endpoint:

CLI

curl

restate deployments register http://localhost:9080

If you run Restate with Docker, use http://host.docker.internal:9080 instead of http://localhost:9080.

Output

❯ SERVICES THAT WILL BE ADDED:

- Greeter

Type: Service

HANDLER INPUT OUTPUT

greet value of content-type 'application/json' value of content-type 'application/json'

✔ Are you sure you want to apply those changes? · yes

✅ DEPLOYMENT:

SERVICE REV

Greeter 1

5

Send a request to the Greeter service

curl localhost:8080/Greeter/greet -H 'content-type: application/json' -d '"Francesco"'

You should now see printed as response: "Greetings Francesco"

🎉

Congratulations, you managed to run your first Restate service!

Next steps

• Read the Concepts
• Discover the key features of Restate in the Tour of Restate
• Run the examples