---
title: "Install speedctl CLI | Speedscale Docs"
description: "Install the speedctl command-line tool for Speedscale platform setup, operator installation, and cloud resource automation. For recording, mocking, and replaying with proxymock, use the proxymock CLI install guide."
canonical: "https://docs.speedscale.com/getting-started/installation/install/cli/"
---
[Documentation index](https://docs.speedscale.com/getting-started/llms.txt) | [Markdown](https://docs.speedscale.com/getting-started/installation/install/cli/index.md) | [Canonical page](https://docs.speedscale.com/getting-started/installation/install/cli/)
# Install speedctl CLI
speedctl is a command-line tool for Speedscale platform setup and cloud resource automation. Use it to install the Speedscale operator, generate manifests, and work with platform resources.
Recording, mocking, or replaying with proxymock?
Follow [Install proxymock CLI](https://docs.speedscale.com/proxymock/getting-started/installation/). For help choosing a tool, see [Command-line tools: proxymock and speedctl](https://docs.speedscale.com/getting-started/command-line-tools/).
These instructions install **speedctl** for platform setup and cloud resource automation. For the proxymock record/mock/replay workflow, follow [Install proxymock CLI](https://docs.speedscale.com/proxymock/getting-started/installation/).
**MacOS**
Install speedctl on macOS with [Homebrew](https://brew.sh/):
```shell
brew install speedscale/tap/speedctl
```
Or via the install script:
```shell
sh -c "$(curl -Lfs https://downloads.speedscale.com/speedctl/install)"
```
Note
You can inspect the install script to see what it does. Root permission is _not_ required to execute this script.
Install a specific version by passing it to the install script:
```shell
sh -c "$(curl -Lfs https://downloads.speedscale.com/speedctl/install)" -s v2.3.86
```
tip
To install non interactively (like in CI/CD) set the `SPEEDSCALE_API_KEY` environment variable to your [API key](https://docs.speedscale.com/quick-start/#retrieve-your-api-key)
Optionally skip the install script and install manually:
```shell
# Download speedctl binary on your machine
curl "https://downloads.speedscale.com/speedctl/speedctl-darwin-$(case $(uname -m) in x86_64) echo 'amd64';; arm | arm64 | aarch64) echo 'arm64';; esac)" -o speedctl
# Create speedscale directory and move the binary to the directory
mkdir ~/.speedscale
mv ./speedctl ~/.speedscale
# Give execute permission to the binary
chmod +x ~/.speedscale/speedctl
```
Reminder
Don't forget to add `speedctl` to your `$PATH` variable in your shell's rcfile:
```shell
# substitute your shell's rcfile
echo "export PATH=\$PATH:$HOME/.speedscale" >> ~/.zshrc
```
**Linux**
Install speedctl on Linux with the install script:
```shell
sh -c "$(curl -Lfs https://downloads.speedscale.com/speedctl/install)"
```
Note
You can inspect the install script to see what it does. Root permission is _not_ required to execute this script.
Install a specific version by passing it to the install script:
```shell
sh -c "$(curl -Lfs https://downloads.speedscale.com/speedctl/install)" -s v2.3.86
```
tip
To install non interactively (like in CI/CD) set the `SPEEDSCALE_API_KEY` environment variable to your [API key](https://docs.speedscale.com/quick-start/#retrieve-your-api-key)
Optionally skip the install script and install manually:
```shell
# Download speedctl binary on your machine
curl "https://downloads.speedscale.com/speedctl/speedctl-linux-$(case $(uname -m) in x86_64) echo 'amd64';; arm | arm64 | aarch64) echo 'arm64';; esac)" -o speedctl
# Create speedscale directory and move the binary to the directory
mkdir ~/.speedscale
mv ./speedctl ~/.speedscale
# Give execute permission to the binary
chmod +x ~/.speedscale/speedctl
```
Reminder
Don't forget to add `speedctl` to your `$PATH` variable in your shell's rcfile:
```shell
# substitute your shell's rcfile
echo "export PATH=\$PATH:$HOME/.speedscale" >> ~/.zshrc
```
**Windows**
Open PowerShell and create a Speedscale directory.
```text
mkdir -f $env:userprofile\.speedscale
```
Download `speedctl` into the Speedscale directory.
```text
curl.exe -L "https://downloads.speedscale.com/speedctl/speedctl.exe" -o $env:userprofile\.speedscale\speedctl.exe
```
If this is your first time using `speedctl` you may need to add the Speedscale directory to your Path environment variable so it is accessible without knowing the full path.
To add the Speedscale directory to your path, right click on the Windows button and click **System**.
Click **Advanced system settings** on the right.
Click **Environment Variables**.
Under **System variables** select **Path** and click **Edit**.
Create a **New** entry in the list with the Speedscale directory. If you are unsure of the exact path run this command from PowerShell.
```text
echo $env:userprofile\.speedscale
```
Click **OK** and restart PowerShell.
If your outbound proxy requires Kerberos for cloud access, configure [Kerberos proxy authentication](https://docs.speedscale.com/reference/proxy_config/) before running `speedctl` cloud commands.
## Verify and initialize
Run `speedctl --help` to verify that the executable is on your PATH. If proxymock is already configured for your enterprise account, [reuse the shared credentials](https://docs.speedscale.com/getting-started/command-line-tools/#credentials). Otherwise run `speedctl init` before using cloud commands and follow the prompts to authorize your Speedscale account. You can get your personal API key from the [Profile page](https://app.speedscale.com/profile).
## Next steps
Continue with the [standard Kubernetes installation](https://docs.speedscale.com/getting-started/installation/install/kubernetes-operator/?method=cli#install-method) to install the operator. For capture and replay from an existing speedctl workflow, see [Capture, replay, and mock with speedctl](https://docs.speedscale.com/guides/cli/). Run `speedctl --help` or `speedctl --help` for commands and flags.