Getting Started with the API

The CLI tool is the easiest way to run end-to-end tests for your application. It supports defining tests either inline with the call, or in specified YML files.

Simple HTTP requests are also supported, and all examples include curl counterparts.

You can install the CLI tool with npm. If you don't have npm, you can install npm on your system via the instructions here.

Once you have installed npm, you can install the CLI command:

npm install -g @walrusai/cli

You can run the following command to verify that the installation worked:

walrus --version

Next, continue to Authentication to create an api token to start running tests.