CLI Reference

This page provides documentation for our command line tools.

agiletest

AgileTest.app CLI tool. See https://AgileTestApp.github.io/agiletest-cli for documentation.

Usage:

Text Only

agiletest [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--client-id	text	Agiletest client id	``
--client-secret	text	Agiletest client secret	``
--base-url	text	Agiletest base url	https://api.agiletest.app
--base-auth-url	text	Agiletest base authentication url	https://jira.agiletest.app
--timeout	integer	Agiletest request timeout	30
--help	boolean	Show this message and exit.	False

Subcommands

• test-execution: Test Execution commands.

test-execution

Test Execution commands.

Usage:

Text Only

agiletest test-execution [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• import: Import a test execution result.
• import-multipart: Import a test execution result in multipart format.

import

Import a test execution result.

Usage:

Text Only

agiletest test-execution import [OPTIONS] [INPUT_FILE]

Options:

Name	Type	Description	Default
-t, --framework-type	choice (junit | nunit | testng | xunit | robot | cucumber | behave)	N/A	_required
-p, --project-key	text	N/A	_required
-te, --test-execution-key	text	N/A	``
--help	boolean	Show this message and exit.	False

import-multipart

Import a test execution result in multipart format.

Usage:

Text Only

agiletest test-execution import-multipart [OPTIONS] [TEST_RESULT]

Options:

Name	Type	Description	Default
-t, --framework-type	choice (junit | nunit | testng | xunit | robot | cucumber | behave)	N/A	_required
-i, --test-info	filename	N/A	<_io.TextIOWrapper name='<stdin>' mode='r' encoding='utf-8'>
--help	boolean	Show this message and exit.	False