> ## Documentation Index
> Fetch the complete documentation index at: https://auk.mamahuhu.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Auk CLI
> Run tests, manage automated API monitoring, and more.
Auk gives you multiple ways to interact with and configure your APIs. With the command-line interface (CLI) you can interact with the Auk platform using a terminal, or through an automated system. This enables you to run API tests, manage automated API monitoring, and more.
This section contains a complete list of all Auk CLI commands available, alongside their optional parameters for additional behavior. You can also find a complete list of configuration options to configure your APIs through Auk.
Auk CLI is currently in alpha stage. Report a bug by [opening a new issue](https://github.com/mamahuhu-io/auk/issues/new/choose).
## Pre-requisites
Before installing the Auk CLI, ensure your system meets the following requirements.
You will need `node-gyp` installed. Thus, follow the instructions from [node-gyp](https://github.com/nodejs/node-gyp).
Execute the following command:
```
sudo apt-get install python g++ build-essential
```
Execute the following command:
```
sudo apk add python3 make g++
```
Execute the following command:
```
sudo yum install gcc72 gcc72-c++
```
Execute the following command:
```
sudo pacman -S make gcc python
```
Execute the following command:
```
sudo dnf install python3 make gcc gcc-c++ zlib-devel brotli-devel openssl-devel libuv-devel
```
## Installing Auk CLI
Once the dependencies are installed, install @auk/cli from npm by running:
```bash theme={null}
npm i -g @auk/cli
```
The **minimum supported Node.js version** for the CLI is now **v22**. If you're on Node.js v20 (EOL in April, 2026), you can continue using CLI `v0.26.0` alongside `v2025.10.1` of the Auk app. Future CLI versions will require Node.js v22 or higher.
## Commands
### `auk test`
The `auk test` command allows you to run tests against a Auk collection file.
* The auk test command recursively goes through each request in the collection and runs them, validating the responses with the test script provided in each request. Hence, the order of execution is the same as the order specified in the collection structure.
* If upon executing the command, a failed assertion (a failing test case) has occurred, the command will give a non-zero exit code and 0 exit code if all tests have passed.
* Unless there was a network error (for example, DNS resolution errors or network Connectivity Issues), the test script will be running and it is up to the test script to define what happens to error status codes. Non-200 status codes are still considered valid responses for test script execution.
```bash theme={null}
auk test [-e ] [-d ]
```
### Running Collections from the Desktop App
The `auk test` command can be used to run collections stored locally in your Auk desktop application.
```bash theme={null}
auk test [-e ] [-d ] [--token ]
```
You can directly copy the command with the auto-populated **Collection ID** and **Environment ID** by navigating to the **”CLI”** tab within the **”Run Collection”** action found in the context menu.
### Generate JUnit Report for Collection Runs
The `auk test` command now has the ability to generate a JUnit Report for collection runs in the CLI. The report is generated as an XML file at the specified path provided in the command. If no path is specified, the report will be saved in the working directory with the default name `auk-junit-report.xml`.
```bash theme={null}
auk test --env --reporter-junit [path]
```
#### JUnit Report Format Overview
The JUnit report generated for collection runs provides a structured summary of the test results. The table below provides a detailed breakdown of the JUnit report format, explaining the significance of each XML element:
| Element | Description |
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `` | Root element representing the entire set of test suites. |
| `` | Represents a collection of test cases for a specific request. |
| `` | Represents an individual test case. It corresponds to `pw.expect()` assertions with the description prefixed by that of the test suite `pw.test()`. It appears as a direct child of ``. |
| `name` | Attribute for `` and `` elements. For ``, it indicates the hierarchy of collections up to the request. Organized at the request level using the naming convention: `//`. While, for ``, it'll be the description. |
| `classname` | Attribute of `` that mirrors the `name` attribute of the parent ``. |
| `` | Indicates an assertion failure within a ``. Includes `type` and `message` attributes describing the failure. |
| `` | Indicates an error during assertion within a ``. Includes `message` attribute describing the error. |
| `` | Represents errors reported at the request level (e.g., invalid URL, reference error in the test script). These errors are detailed within a `CDATA` section, with each error separated by newlines to ensure each issue is clearly identified. |
| `time` | Attribute of `` that shows the execution time for the test cases (excluding request execution time). The total time is at the root ``. |
| `timestamp` | Attribute of `` that records the execution date and time in ISO string format. |
| `tests`, `failures`, `errors` | Attributes of `` and `` that track the number of test cases, failed cases, and errors, at the request level and effective count at the root level test suite respectively. Set to `0` at a request level test suite, if errors halt further execution. |
### Arguments
* `auk collection id` : Each collection created in a Auk workspace is given a unique identifier known as the Collection ID. Collection IDs for each collection can be found under **“Details”** tab inside Collection **“Properties”**.
* `environment id` : Similar to Collection IDs, each environment created in a Auk workspace is assigned a unique identifier known as the Environment ID.
* `delay_i_ms` : Represents a time interval (in milliseconds) to pause execution of API requests before within a collection.
* `access token` : It is a secure, unique identifier used to authenticate a user's access to their Auk account and its resources like collections, environments data.
* `path` : Accounts for a file path where the JUnit report will be saved as an XML file in your file system.
* `no_of_iterations`: Indicates the number of iterations to run the collection. Each iteration will run the entire collection once, replacing any iteration-specific data defined by the `--iteration-data` flag (if provided).
```bash theme={null}
auk test [--iteration-count ] [--iteration-data ]
```
* `file_path`: The path to the CSV file for iteration data. This file should follow the format:
```
key1,key2,key3
value1,value2,value3
value4,value5,value6
```
Each row in the CSV corresponds to an iteration, and the values from that row will replace the respective environment variables during the iteration. For example:
* **Iteration 1:** The values value1, value2, and value3 will be used.
* **Iteration 2:** The values value4, value5, and value6 will be used.
### Example
```bash theme={null}
auk test kitchen-sink-auk-collection.json
auk test -e environment.json kitchen-sink-auk-collection.json
auk test -e environment.json -d 1000 kitchen-sink-auk-collection.json
auk test clxsntdgh0000lcx9fnits2h8 --token
auk test -e clxspay2r0006lcx99aqgjbay -d 1000 clxsntdgh0000lcx9fnits2h8 --token
auk test -e environment.json kitchen-sink-auk-collection.json --reporter-junit kitchen-sink-junit.xml
auk test kitchen-sink-auk-collection.json --iteration-count 3 --iteration-data /path/to/iteration-data.csv
```
## Environment
Auk allows templates in several places. For example, you could specify your endpoint URL as `<>/post` and specify baseurl as [`https://echo.mamahuhu.io`](https://echo.mamahuhu.io) in an environment file.
Auk CLI supports environment files in two specific formats:
### 1. Single Environment Entry Export Format
This format is generated by Auk App when you export any of your environment. It includes a named environment (name) with key-value pairs, allowing you to define various variables within a single file.
```json theme={null}
{
"name": "my_env",
"variables": [
{
"key": "base_url",
"value": "https://echo.mamahuhu.io"
},
{
"key": "auth_token",
"value": "xxxxxxxxxxxx"
}
]
}
```
### 2. Legacy Export Format
Auk CLI continues to support the legacy format which was previously the only accepted format used by CLI.
```json theme={null}
{
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
```
### 3. Environment ID
To use an environment on your API client using its ID, click on the `Properties` action present in the **menu icon** next to each environment. Within the Details section, you'll find the **Environment ID**. Copy this ID and use it in the Auk CLI for execution.
Please note that the Auk CLI exclusively supports the above three formats for importing environment variables. It **does not** offer compatibility with **Bulk Environment** exports or **any other export** format.
## Secrets
If requests in a collection consists of secret variables we recommend either of the two approaches.
1. Inject the secret values as variables into the OS environment
2. Edit the environment export file and add the secret values manually
## Options
| Option | Description |
| ------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `-h` | Gives a list of associated commands and their descriptions |
| `-v` | Displays the current version of the CLI |
| `--env or -e` | Accepts environments in all the formats present in [Environment section](/documentation/clients/cli#environment). |
| `--delay` or `-d` | Used to defer the execution of requests in a collection. |
| `--token` | Expects a personal access token to be passed for establishing connection with your Auk account. |
| `--reporter-junit` | Expects a file path to store the JUnit Report. |
| `--iteration-count` | Defines the number of iterations to run the collection. |
| `--iteration-data` | Accepts the path to a CSV file that contains iteration data. |
| `--legacy-sandbox` | Opt-out from the latest experimental scripting sandbox. |
## Test Report Components
Upon executing the commands, a comprehensive test report is generated, offering detailed insights into the performance of each request. Below, you'll find a breakdown of the components outlined in the test summary for the exported API Collection:
Each instance of `pw.expect()` within the testScript of a request is considered a test case.
Each invocation of `pw.test()` within the testScript of a request is regarded as a test suite.
The total number of `testScript` fields across all requests in the provided collection export file, representing the overall number of test scripts executed.
The total time taken to execute all test cases within the collection.
The total number of requests executed within the collection.
The cumulative time taken to execute all requests within the collection.
The scripts executed prior to each request. The count matches the number of requests in the provided collection export file.