Skip to content

AgileTest CLI⚓︎

AgileTest CLI is a command line interface for AgileTest - a test case management tool for agile teams.

For other documentations, visit AgileTest Documentation.

Quick Start⚓︎

AgileTest CLI is available as:

For full CLI documentation, visit AgileTest CLI Documentation.

CI/CD Integration⚓︎

See CI/CD Integration for examples of how to integrate AgileTest CLI with popular CI/CD tools.

Authentication with Cloud Edition⚓︎

To use the CLI, you need to generate a pair of client ID and client secret from AgileTest.

You can pass the client ID and client secret as command line arguments:

Bash
agiletest --client-id your_client_id --client-secret your_client_secret [COMMANDS]

Or set them as environment variables:

Cloud Edition:

Bash
export AGILETEST_CLIENT_ID=your_client_id
export AGILETEST_CLIENT_SECRET=your_client_secret

Authentication with Data Center Edition⚓︎

In Data Center, you need to generate a personal access token for your Jira account.

You can pass the personal access token as command line arguments, together with your Jira instance base URL:

Bash
agiletest --data-center --data-center-token your_personal_access_token --base-url https://your-jira-datacenter-instance.com [COMMANDS]

Or set them as environment variables:

Bash
export AGILETEST_DC_TOKEN=your_personal_access_token
export AGILETEST_BASE_URL=https://your-jira-datacenter-instance.com

Import Test Execution Results⚓︎

Example: Import test execution results from a JUnit XML file tests/junit-test-data.xml to a Test Execution issue in AgileTest.

Cloud Edition:

Bash
# with python CLI
agiletest --client-id your_client_id --client-secret your_client_secret \
    test-execution import \
    --framework-type junit --project-key TC \
    --test-execution-key TC-202 tests/junit-test-data.xml

# or with docker
docker run --rm -i \
    -e AGILETEST_CLIENT_ID=your_client_id \
    -e AGILETEST_CLIENT_SECRET=your_client_secret \
    ghcr.io/agiletestapp/agiletest-cli \
    test-execution import \
    --framework-type junit --project-key TC \
    --test-execution-key TC-202 <tests/junit-test-data.xml

Data Center Edition:

Bash
# with python CLI
agiletest --data-center \
    --data-center-token your_personal_access_token \
    --base-url https://your-jira-datacenter-instance.com \
    test-execution import \
    --framework-type junit --project-key TC \
    --test-execution-key TC-202 tests/junit-test-data.xml

# or with docker
docker run --rm -i \
    -e AGILETEST_DC_TOKEN=your_personal_access_token \
    -e AGILETEST_BASE_URL=https://your-jira-datacenter-instance.com \
    ghcr.io/agiletestapp/agiletest-cli \
    --data-center \
    test-execution import \
    --framework-type junit --project-key TC \
    --test-execution-key TC-202 <tests/junit-test-data.xml

Install from source⚓︎

The CLI requires Python 3.10 or later.

Bash
# Clone the repo
git clone https://github.com/AgileTestApp/agiletest-cli.git

cd agiletest-cli

# Install the package
pip install .