Install the CLI
The rudder CLI is one file with nothing to install beside it. It signs you in, installs
modules of the marketplace, generates the client of your project and shows the calls of your
game; see the CLI.
Install
Section titled “Install”macOS and Linux:
curl -fsSL https://rudder.build/install.sh | shWindows, in PowerShell:
irm https://rudder.build/install.ps1 | iexThe line downloads the file of your system, checks it against SHA256SUMS and puts it on your
PATH: ~/.local/bin on macOS and Linux, %LOCALAPPDATA%\rudder\bin on Windows. It says so
when it had to change the PATH, and a new terminal picks that up. Run the same line again to
update, or let the installed CLI do it: rudder update
replaces the binary with the newest release, and every command tells you when there is one.
RUDDER_VERSION=1.6.0 (or $env:RUDDER_VERSION = '1.6.0') installs one release instead of the
newest.
Sign in
Section titled “Sign in”rudder loginThe command opens the Dashboard in your browser with a code, and approving it signs the CLI in.
On a machine without a browser, rudder login --no-browser prints the address to open elsewhere.
Either way the CLI keeps a personal access token of the account, named cli <hostname>, which
Settings → Personal Access Tokens lists and revokes.
Install by hand
Section titled “Install by hand”| System | Machine | File | SHA-256 |
|---|---|---|---|
| macOS | Apple silicon | rudder-…-darwin-arm64 | … |
| macOS | Intel | rudder-…-darwin-amd64 | … |
| Linux | x86-64 | rudder-…-linux-amd64 | … |
| Linux | ARM64 | rudder-…-linux-arm64 | … |
| Windows | x86-64 | rudder-…-windows-amd64.exe | … |
SHA256SUMS holds the checksums of every file, and /download/ lists the files.
macOS and Linux
Section titled “macOS and Linux”shasum -a 256 -c SHA256SUMS --ignore-missingchmod +x rudder-*-darwin-arm64sudo mv rudder-*-darwin-arm64 /usr/local/bin/rudderUse the name of your file in place of darwin-arm64. On macOS a file downloaded by a browser
is held by Gatekeeper; clear it once:
xattr -d com.apple.quarantine /usr/local/bin/rudderWindows
Section titled “Windows”Check the file in PowerShell and compare the hash with its line of SHA256SUMS:
Get-FileHash .\rudder-*-windows-amd64.exe -Algorithm SHA256Rename it to rudder.exe and move it into a folder on your PATH.
Check the install
Section titled “Check the install”rudder versionClient SDKs
Section titled “Client SDKs”The SDK core of your engine, which the client rudder client generate writes for your project
calls into, installs from the Rudder package registry, no account needed:
https://hub.rudder.build/api/packages/rudder/npm/. See Unity and C#
and TypeScript.