The speedctl command line tool is used to interact with Speedscale from your own terminal.
speedctl is the Speedscale
programmable API and the primary way to perform setup actions like installing the Speedscale Operator, generating manifests, etc.
Start by installing
speedctl the Speedscale CLI-based API via Homebrew:
brew install speedscale/tap/speedctl
Or via the install script:
sh -c "$(curl -Lfs https://downloads.speedscale.com/speedctl/install)"
Open PowerShell and create a Speedscale directory.
mkdir -f $env:userprofile\.speedscale
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.
Click OK and restart PowerShell.
If this is your first time downloading
speedctl initialization may happen automatically. Otherwise bootstrap your local environment:
You will need to get your API key from your Profile Page. Copy the API key and paste when prompted.
Verify your installation:
After installing the Speedscale Operator, the quickest way to experience what Speedscale has to offer is via the
This command will deploy a demo workload, create a snapshot and run replays so that you can get a head start without having to instrument your own apps.