Welcome to the new Golem Cloud Docs! 👋
Documentation
CLI

Golem CLI Introduction

Golem CLI is a command-line interface for interacting with Golem. Golem CLI allows users to upload their components, launch new workers based on these components and call functions on running workers.

Golem CLI versions

There are 3 different Golem CLI versions available for installation:

  • Universal golem-cli that supports both open sourse and hosted versions of Golem.
  • Open source specific golem-cli without support for the hosted version of Golem.
  • Cloud version without support for the open source version of Golem.

The universla Golem CLI includes all the functionality of the open source specific Golem CLI and Golem Cloud CLI. For these examples we will use universal golem-cli unless specified otherwise.

Installation

There are two ways to install any of the above described versions of Golem CLI:

  • Downloading a precompiled platform-specific binary
  • Installing from source using Rust tooling

Open source specific golem-cli and universal golem-cli can not be installed at the same time.

Downloading precompiled binaries

You can download the precompiled version of golem-cli from one of the following pages:

Universal and Golem Cloud ReleasesOpen Source Golem Releases

We provide precompiled binaries for the following platforms:

  • Mac arm64
  • Mac x86_6
  • Linux arm64
  • Linux x86_64
  • Windows x86_64

Some platforms may protect by default from running these downloaded binaries. You may need to allow running them in your system settings.

Installing from source

To build golem-cli you need to use cargo, Rust's build tool, and the build will require protoc, the protobuf (opens in a new tab) compiler.

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

To install protoc see https://grpc.io/docs/protoc-installation/ (opens in a new tab). Make sure to install version 3.15 or higher.

Then use one of the following commands to install the desired version of Golem CLI:

Universal Golem CLI
cargo install --features universal golem-cloud-cli
Open source Golem CLI
cargo install golem-cli
Cloud-only Golem CLI
cargo install golem-cloud-cli --bin golem-cloud-cli

Profiles

The Golem CLI can have multiple profiles configured, each selecting a specific Golem cluster to connect to, as well as some settings like the default output format.

See the Golem CLI profiles page for more information.

Working with components

Golem CLI can manage Golem Components. See the Golem CLI components page for details.

Interacting with workers

Golem CLI allows creating, invoking and observing Golem Workers. See the Golem CLI workers page for more information.

MetadataShell completion