We use cookies

We use cookies to ensure you get the best experience on our website. For more information on how we use cookies, please see our cookie policy.

By clicking "Accept", you agree to our use of cookies.
Learn more.

User GuideHatchet Cloud Quickstart

Hatchet Cloud Quickstart

Welcome to Hatchet! This guide walks you through getting set up on Hatchet Cloud. If you’d like to self-host Hatchet, please see the self-hosted quickstart instead.

Quickstart

Sign up

If you haven’t already signed up for Hatchet Cloud, please register here.

Set up your tenant

In Hatchet Cloud, you’ll be shown a screen to create your first tenant. A tenant is a logical separation of your environments (e.g. dev, staging, production). Each tenant has its own set of users who can access it.

After creating the tenant, you can simply follow the instructions in the Hatchet Cloud dashboard to set up your first quickstart project and workflow. We have copied the instructions in the following steps.

Install the Hatchet CLI

MacOS, Linux, WSL

curl -fsSL https://install.hatchet.run/install.sh | bash

Set your Hatchet profile

You will need to create a Hatchet CLI profile to connect to your Hatchet Cloud tenant. You can do this using the hatchet profile add command:

hatchet profile add

Note that the Hatchet Cloud dashboard will provide you with an API token to use when creating your profile.

Run the quickstart

You can run the Hatchet Cloud quickstart using the hatchet quickstart command:

hatchet quickstart

Run your worker

After setting up the quickstart project, you can run your worker locally by following the instructions printed after the quickstart command. This will involve using the hatchet worker dev command:

hatchet worker dev

Trigger a workflow

Finally, you can trigger your workflow using the hatchet trigger simple command:

hatchet trigger simple

And that’s it! You should now have a Hatchet project set up on Hatchet Cloud with a worker running locally.

Next Steps

Once you’ve completed the quickstart, you can explore a more in-depth walkthrough of Hatchet using the walkthrough guide.