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.
Follow Install proxymock CLI. For help choosing a tool, see Command-line tools: proxymock and speedctl.
These instructions install speedctl for platform setup and cloud resource automation. For the proxymock record/mock/replay workflow, follow Install proxymock CLI.
- MacOS
- Linux
- Windows
Install speedctl on macOS with Homebrew:
brew install speedscale/tap/speedctl
Or via the install script:
sh -c "$(curl -Lfs https://downloads.speedscale.com/speedctl/install)"
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:
sh -c "$(curl -Lfs https://downloads.speedscale.com/speedctl/install)" -s v2.3.86
To install non interactively (like in CI/CD) set the SPEEDSCALE_API_KEY environment variable to your API key
Optionally skip the install script and install manually:
# 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
Don't forget to add speedctl to your $PATH variable in your shell's rcfile:
# substitute your shell's rcfile
echo "export PATH=\$PATH:$HOME/.speedscale" >> ~/.zshrc
Install speedctl on Linux with the install script:
sh -c "$(curl -Lfs https://downloads.speedscale.com/speedctl/install)"
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:
sh -c "$(curl -Lfs https://downloads.speedscale.com/speedctl/install)" -s v2.3.86
To install non interactively (like in CI/CD) set the SPEEDSCALE_API_KEY environment variable to your API key
Optionally skip the install script and install manually:
# 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
Don't forget to add speedctl to your $PATH variable in your shell's rcfile:
# substitute your shell's rcfile
echo "export PATH=\$PATH:$HOME/.speedscale" >> ~/.zshrc
Open PowerShell and create a Speedscale directory.
mkdir -f $env:userprofile\.speedscale
Download speedctl into the Speedscale directory.
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.
echo $env:userprofile\.speedscale
Click OK and restart PowerShell.
If your outbound proxy requires Kerberos for cloud access, configure Kerberos proxy authentication 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. 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.
Next steps
Continue with the platform quick start to install the operator. For capture and replay from an existing speedctl workflow, see Capture, replay, and mock with speedctl. Run speedctl --help or speedctl <command> --help for commands and flags.