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`
`--data-center`	boolean	Agiletest Data Center Edition	`False`
`--data-center-token`	text	Agiletest Data Center Token	``
`--help`	boolean	Show this message and exit.	`False`

Subcommands

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 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	``
`-pk`, `--test-plan-keys`	text	N/A	`[]`
`-envs`, `--test-environments`	text	N/A	`[]`
`-fv`, `--fix-versions`	text	N/A	`[]`
`-m`, `--milestone-id`	integer	N/A	`-1`
`-r`, `--revision`	text	N/A	``
`--help`	boolean	Show this message and exit.	`False`

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`