CLI Installation - Documentation

This guide will help you install the Heyweek CLI on your system. The CLI is available for macOS, Windows, and Linux distributions (including Ubuntu, Debian, Fedora, Red Hat, and Rocky Linux), and we provide several installation methods so you can pick the one that fits your platform.

The CLI is written in Go (1.24+), distributed under the MIT license, and automatically checks for updates every 24 hours.

Install with Homebrew (macOS or Linux)

We maintain a Homebrew tap for installing the Heyweek CLI:

brew tap heyweek/heyweek-cli
brew <span class="token function">install</span> heyweek-cli

Install on Debian / Ubuntu (apt or dpkg)

Download the .deb package for your architecture from the releases page, then install it from the directory you downloaded it to:

<span class="token function">sudo</span> <span class="token function">apt</span> <span class="token function">install</span> ./Heyweek_<span class="token operator">&lt;</span>version<span class="token operator">></span>_linux_<span class="token operator">&lt;</span>arch<span class="token operator">></span>.deb

Or, using dpkg:

<span class="token function">sudo</span> dpkg <span class="token parameter variable">-i</span> Heyweek_<span class="token operator">&lt;</span>version<span class="token operator">></span>_linux_<span class="token operator">&lt;</span>arch<span class="token operator">></span>.deb

After installing, run hw version to confirm. If you get a "command not found" error, try reinstalling:

<span class="token function">sudo</span> <span class="token function">apt</span> <span class="token function">install</span> <span class="token parameter variable">--reinstall</span> ./Heyweek_<span class="token operator">&lt;</span>version<span class="token operator">></span>_linux_<span class="token operator">&lt;</span>arch<span class="token operator">></span>.deb

You can remove the downloaded package once installation is complete:

<span class="token function">rm</span> Heyweek_<span class="token operator">&lt;</span>version<span class="token operator">></span>_linux_<span class="token operator">&lt;</span>arch<span class="token operator">></span>.deb

Install on Fedora / RHEL / Rocky Linux (dnf)

Download the .rpm package for your architecture from the releases page, then install it:

<span class="token function">sudo</span> dnf <span class="token function">install</span> Heyweek_<span class="token operator">&lt;</span>version<span class="token operator">></span>_linux_<span class="token operator">&lt;</span>arch<span class="token operator">></span>.rpm

Install on Windows (Scoop)

The Heyweek CLI is available on Windows via the Scoop package manager:

scoop bucket <span class="token function">add</span> heyweek https://github.com/heyweek/homebrew-heyweek-cli.git
scoop <span class="token function">install</span> heyweek

Verifying signed artifacts

All releases are signed with cosign. The public key (cosign.pub), signatures, and checksum files for each release are available on the releases page.

Make sure cosign is installed, download cosign.pub and the checksum bundle from the releases page, then verify the checksums file against the public key:

cosign verify-blob <span class="token punctuation">\</span>
  <span class="token parameter variable">--bundle</span> Heyweek-mac-checksums.txt.sigstore.json <span class="token punctuation">\</span>
  <span class="token parameter variable">--key</span> cosign.pub <span class="token punctuation">\</span>
  Heyweek-mac-checksums.txt

A successful verification prints Verified OK. You can then verify the binary against the checksums:

shasum <span class="token parameter variable">-a</span> <span class="token number">256</span> <span class="token parameter variable">-c</span> Heyweek-mac-checksums.txt

Confirm the installation

Run hw version to confirm the CLI is installed correctly:

hw version

Next steps

Log in: Run hw auth login to connect to your Heyweek account.
Explore commands: See the Commands Reference for everything the CLI can do.
Configure preferences: See Configuration to set your default workspace and other options.

You can display help for any command with the --help flag, for example hw project --help.