Golem CLI installation from source

If the precompiled binaries are not available for your platform, or you prefer to install from source, you can build it with the Rust toolchain.

Prerequisites

To build golem-cli you need to use cargo, Rust's build tool.

To get cargo on your system, we recommend using rustup (opens in a new tab):

Terminal

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup install stable
rustup default stable

Installing Golem binaries

⚠️

Note that currently installing from crates.io is not possible because the package requires a patched wasmtime version. Always use the --git parameter for our precompiled binaries.

The Golem binaries come in two flavors:

The golem-cli command is the lightweight version of Golem's command line interface, which allows you to interact with a running Golem cluster, but it does not include a built-in local version of Golem itself.
The golem binary is the full version of Golem's command line interface, containing everything golem-cli has, and it also includes a built-in local version of Golem itself.

For generic usage and local development we recommend using the golem binary.

The smaller golem-cli binary can be useful for CI, CD and dev-ops purposes, if the built-in local server is not required for a specific task.

To install golem or golem-cli from source, use cargo install:

cargo install golem --git https://github.com/golemcloud/golem --tag v1.4.2 --locked

This will create a binary file named golem in the ~/.cargo/bin directory.

Shell Completion Desktop