StormForge CLI
3 minute read
The StormForge CLI is a standalone binary that provides the core set of capabilities for managing Optimize Live.
- If you haven’t already, create a StormForge account at app.stormforge.io/signup.
- Alternatively, log in to our sandbox, then install and authenticate to explore the CLI without impacting workloads.
Install
You can download and install using:
Choose one of the two methods below to install the StormForge CLI.
Copy the following command to a terminal window:
# Automatically selects either AMD64 or ARM64 architecture, downloads
# the appropriate binary, then moves it to a location in PATH
{ [ "$(uname -sm)" = "Linux x86_64" ] && curl -L https://downloads.stormforge.io/stormforge-cli/latest/stormforge_linux_amd64.tar.gz | tar -xz; } ||
{ [ "$(uname -sm)" = "Linux aarch64" ] && curl -L https://downloads.stormforge.io/stormforge-cli/latest/stormforge_linux_arm64.tar.gz | tar -xz; } &&
sudo mv stormforge /usr/local/bin/
Download the appropriate Linux binary and extract the files.
Then, run:
sudo mv stormforge /usr/local/bin/
Choose one of the two methods below to install the StormForge CLI.
Download the appropriate Windows binary and extract the files.
Then, move stormforge.exe to a folder defined in your Windows PATH environment variable.
Run the following PowerShell install command:
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
If ($env:PROCESSOR_ARCHITECTURE -eq "AMD64") { Invoke-WebRequest -Uri "https://downloads.stormforge.io/stormforge-cli/latest/stormforge_windows_amd64.zip" -Outfile "stormforge.zip" }
If ($env:PROCESSOR_ARCHITECTURE -eq "ARM64") { Invoke-WebRequest -Uri "https://downloads.stormforge.io/stormforge-cli/latest/stormforge_windows_arm64.zip" -Outfile "stormforge.zip" }
Expand-Archive "stormforge.zip" "." -WarningVariable $w; if ($w.Count -eq 0) { Remove-Item "stormforge.zip" }
Then, move stormforge.exe to a folder defined in your Windows PATH environment variable.
Choose one of the three methods below to install the StormForge CLI.
Homebrew:
brew install thestormforge/tap/stormforge
Copy the following macOS install command to a terminal:
# Automatically selects either AMD64 or ARM64 architecture, downloads
# the appropriate binary, then moves it to a location in PATH
{ [ "$(uname -sm)" = "Darwin x86_64" ] && curl -L https://downloads.stormforge.io/stormforge-cli/latest/stormforge_darwin_amd64.tar.gz | tar -xz; } ||
{ [ "$(uname -sm)" = "Darwin arm64" ] && curl -L https://downloads.stormforge.io/stormforge-cli/latest/stormforge_darwin_arm64.tar.gz | tar -xz; } &&
sudo mv stormforge /usr/local/bin/
Download the appropriate macOS binary and install it using your preferred binary installer.
We provide a container image at registry.stormforge.io/library/stormforge-cli (for linux/amd64 and linux/arm64):
docker pull registry.stormforge.io/library/stormforge-cli
If you prefer to use the container image directly, set the STORMFORGE_TOKEN environment variable (from auth create -o token).
Authenticate
Before using other CLI commands, authenticate your session:
stormforge login
This command opens a browser and attempts to authenticate using your StormForge account. If you aren’t already logged in, you will be prompted to sign in.
See the CLI reference for stormforge login for additional details and options.
Once authenticated, you’re ready to use the StormForge CLI.
Releases
The list of releases for the CLI can be viewed on the Release History page.
Documentation
Continue to the next page to view usage documentation.