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.

CLI ReferenceSetup & Installation

Hatchet CLI Setup & Installation

⚠️

The Hatchet CLI is currently in beta and may have breaking changes in future releases.

The Hatchet CLI is a command-line tool with utilities for running workers locally, interacting with a running Hatchet deployment, and running a local Hatchet instance for development.

Features

  • Quickstarts: the hatchet quickstart command sets up a local Hatchet instance with a sample project to help you get started quickly.

  • Local worker reloading: the hatchet worker dev command lets you run a worker locally with automatic reloading when code changes are detected.

  • A full built-in TUI: the hatchet tui command lets you interact with your Hatchet deployment through a terminal user interface (TUI) that provides real-time observability into tasks, workflows, workers, and more.

  • Profiles: the hatchet profile commands allow you to manage multiple Hatchet instances and tenants with named profiles, making it easy to switch between different environments.

Installation

The recommended way to install the Hatchet CLI is via our install script or Homebrew:

MacOS, Linux, WSL

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

Verifying Installation

After installation, verify that the Hatchet CLI is installed correctly by checking its version:

hatchet --version
Profiles