Foundry CLI

Note: The Foundry CLI is not currently officially supported. Please refer to our API documentation.

Introduction

The Foundry CLI helps you manage Foundry instances directly from the command line.

It's simple to install and has few dependencies.

You can use the Foundry CLI to:

• Register and Configure your Foundry account: The first step is to register a Foundry account and configure your credentials.

• Manage Foundry Instances: Once you have an account, you can request, start, and terminate Foundry instances. You can also track your account status and manage your instances.

You're on your way to becoming a Foundry user!

Installation

Please select one of the following installation methods based on your operating system and processor variant.

If you are using a Mac, you may get a warning that the package developer cannot be verified. You can press "Move to trash" and proceed with using the CLI.

Single-command installation for macOS/Linux

Note: this command requires sudo.

curl https://foundry-distro.s3.us-west-1.amazonaws.com/foundry-download.sh | sh

Manually install with tarball

• Mac (Apple Silicon)

• Mac (Intel)

• Windows (x86)

• Windows (x64)

• Linux (x64)

• Linux (arm)

Usage

Head over to the CLI reference for a comprehensive list of the commands the Foundry CLI supports.