🧑‍💻 Waldo CLI

Using Waldo CLI, you can:

• Authenticate user access to Waldo with an API token.
• Upload an iOS or Android build to Waldo for processing.
• Trigger a run of of one or more test flows for your app.

Installation

Waldo CLI is open-source and is hosted on GitHub

📘

Note: If you intend to use Waldo CLI from a CI script, please refer to the next section — Installation for CI — for instructions.

Linux and macOS

To install Waldo CLI, simply download and execute the installer script:

curl -fLs https://github.com/waldoapp/waldo-go-cli/raw/master/install.sh | bash

By default, the script installs Waldo CLI to ~/.waldo/bin.

If you wish to install Waldo CLI to a different location, simply define the WALDO_CLI_BIN environment variable before invoking the installer script:

export WALDO_CLI_BIN=/path/to/binary
curl -fLs https://github.com/waldoapp/waldo-go-cli/raw/master/install.sh | bash

📘

Note: If the installer script is able to find a previous Waldo CLI installation (using which waldo), the script re-installs the latest version of Waldo CLI to the same location, unless you override this location with the WALDO_CLI_BIN environment variable.

You can verify that you have installed Waldo CLI correctly with the which waldo and waldo help commands.

If you ever need to uninstall Waldo CLI, simply delete the executable from the install location.

Windows

To install Waldo CLI, simply navigate to the latest release, download the appropriate waldo executable for your machine (either waldo-windows-x86_64.exe or waldo-windows-arm64.exe), and install it as waldo.exe to a location known to %PATH%.

You can verify that you have installed it correctly with the waldo help command.

If you ever need to uninstall Waldo CLI, simply delete the executable from the install location.

Installation for CI

📘

Note: If you intend to use Waldo CLI interactively, please refer to the previous section — Installation — for instructions.

Linux and macOS

To install Waldo CLI, simply download and execute the installer script:

curl -fLs https://github.com/waldoapp/waldo-go-cli/raw/master/install-waldo.sh | bash

By default, the script installs Waldo CLI to /usr/local/bin.

If you wish to install Waldo CLI to a different location, simply define the WALDO_CLI_BIN environment variable before invoking the installer script:

export WALDO_CLI_BIN=/path/to/binary
curl -fLs https://github.com/waldoapp/waldo-go-cli/raw/master/install-waldo.sh | bash

You can verify that you have installed Waldo CLI correctly with the which waldo and waldo help commands.

If you ever need to uninstall Waldo CLI, simply delete the executable from the install location.

Windows

To install Waldo CLI, simply navigate to the latest release, download the appropriate waldo executable for your machine (either waldo-windows-x86_64.exe or waldo-windows-arm64.exe), and install it as waldo.exe to a location known to %PATH%.

You can verify that you have installed it correctly with the waldo help command.

If you ever need to uninstall Waldo CLI, simply delete the executable from the install location.

Usage

In order to use Waldo CLI to upload an existing build of your app, you need to obtain the upload token from Waldo for your app. This is used to authenticate with the Waldo backend on each call to waldo upload.

$ waldo upload /path/to/YourApp --upload_token <<waldoUploadToken>>

Waldo CLI recognizes the following file extensions:

• .app for iOS simulator builds
• .apk for Android emulator builds

Important: Make sure you replace the fake upload token value shown above with the real value for your Waldo app.

You can also use an environment variable to provide the upload token to Waldo CLI:

$ export WALDO_UPLOAD_TOKEN=<<waldoUploadToken>>
$ waldo upload /path/to/YourApp.app

Advanced Usage

Whereas only the build path and upload token are required to successfully upload your build to Waldo, there are a few other non-required options recognized by Waldo CLI that you may find useful:

• --verbose — If you specify this option, Waldo CLI prints additional debug information. This can shed more light on why your build is failing to upload.
• --git_commit <value> and --git_branch <value> — If you have git installed and you are running from the working directory of a git repository, Waldo CLI attempts to “infer” the most likely commit SHA and branch name to associate with your build. In most cases it works very well. However, some CIs make it difficult or impossible for Waldo CLI to deduce this information. In such cases, you can directly specify the git information to associate with your build using these options.