Autify CLI can help your integration with Autify!
See our official document: https://help.autify.com/docs/autify-command-line-interface
autify connect access-point createautify connect access-point setautify connect client install [VERSION]autify connect client startautify help [COMMAND]autify mobile api describe-test-resultautify mobile api list-test-resultsautify mobile api run-test-planautify mobile api upload-buildautify mobile auth loginautify mobile build upload BUILD-PATHautify mobile test run TEST-PLAN-URLautify mobile test wait TEST-RESULT-URLautify update [CHANNEL]autify web api create-access-pointautify web api create-test-plan-variableautify web api create-url-replacementautify web api delete-access-pointautify web api delete-test-plan-variableautify web api delete-url-replacementautify web api describe-resultautify web api describe-scenarioautify web api execute-scenariosautify web api execute-scheduleautify web api get-credit-usageautify web api get-project-infoautify web api list-access-pointsautify web api list-capabilitiesautify web api list-resultsautify web api list-scenariosautify web api list-test-plan-variableautify web api list-url-replacementsautify web api update-test-plan-variableautify web api update-url-replacementautify web auth loginautify web test run SCENARIO-OR-TEST-PLAN-URLautify web test wait TEST-RESULT-URL
Create an Autify Connect Access Point
USAGE
$ autify connect access-point create --name <value> [--web-workspace-id <value>]
FLAGS
--name=<value> (required) Name of Autify Connect Access Point to be created
--web-workspace-id=<value> Workspace ID of Autify for Web to which the Access Point will belong
DESCRIPTION
Create an Autify Connect Access Point
EXAMPLES
$ autify connect access-point create --name NAME --web-workspace-id ID
See code: src/commands/connect/access-point/create.ts
Set Autify Connect Access Point
USAGE
$ autify connect access-point set --name <value>
FLAGS
--name=<value> (required) Name of the Autify Connect Access Point already created
DESCRIPTION
Set Autify Connect Access Point
EXAMPLES
Start interactive setup:
$ autify connect access-point set --name=NAME
Reading the key from file:
$ autify connect access-point set --name=NAME < key.txt
See code: src/commands/connect/access-point/set.ts
Install Autify Connect Client
USAGE
$ autify connect client install [VERSION]
ARGUMENTS
VERSION [default: v1.0.2] Specify the target version of Autify Connect Client.
DESCRIPTION
Install Autify Connect Client
EXAMPLES
(Recommended) Install the supported version:
$ autify connect client install
Install a specific version:
$ autify connect client install v0.6.1
Install a stable version:
$ autify connect client install stable
See code: src/commands/connect/client/install.ts
Start Autify Connect Client
USAGE
$ autify connect client start [--verbose] [--file-logging] [--debug-server-port <value>] [--web-workspace-id <value>]
[--extra-arguments <value>]
FLAGS
--debug-server-port=<value> The server for debugging and monitoring launches on your local machine on the given port.
It will use a radom port if not specified.
--extra-arguments=<value> Extra command line arguments you want to pass to Autify Connect Client e.g.
"--tunnel-proxy http://proxy".
--file-logging Logging Autify Connect Client log to a file instead of console.
--verbose Make the operation more talkative.
--web-workspace-id=<value> Workspace ID of Autify for Web to create an ephemeral Access Point. If not specified, it
will use the one configured by `autify connect access-point create/set`, instead.
DESCRIPTION
Start Autify Connect Client
EXAMPLES
With pre-created Access Point:
$ autify connect client start
With ephemeral Access Point of Autify for Web:
$ autify connect client start --web-workspace-id 000
See code: src/commands/connect/client/start.ts
Display help for autify.
USAGE
$ autify help [COMMAND...] [-n]
ARGUMENTS
COMMAND... Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for autify.
See code: @oclif/plugin-help
Get a test result.
USAGE
$ autify mobile api describe-test-result --project-id <value> --id <value>
FLAGS
--id=<value> (required) Test Result ID.
--project-id=<value> (required) ID of the project from which the test results will be obtained.
DESCRIPTION
Get a test result.
EXAMPLES
$ autify mobile api describe-test-result
See code: src/commands/mobile/api/describe-test-result.ts
List test results.
USAGE
$ autify mobile api list-test-results --project-id <value> [--page <value>] [--per-page <value>] [--test-plan-id
<value>]
FLAGS
--page=<value> Page number to be retrieved.
--per-page=<value> Number of test results per page.
--project-id=<value> (required) ID of the project from which the list of test results will be retrieved.
--test-plan-id=<value> ID of the test plan.
DESCRIPTION
List test results.
EXAMPLES
$ autify mobile api list-test-results
See code: src/commands/mobile/api/list-test-results.ts
Run a test plan
USAGE
$ autify mobile api run-test-plan --test-plan-id <value> --run-test-plan-request <value>
FLAGS
--run-test-plan-request=<value> (required) A JSON object with the build_id to execute the test plan. e.g.
{"build_id":"string"}
--test-plan-id=<value> (required) The ID of the test plan to run.
DESCRIPTION
Run a test plan
EXAMPLES
$ autify mobile api run-test-plan
See code: src/commands/mobile/api/run-test-plan.ts
Upload the build file.
USAGE
$ autify mobile api upload-build --project-id <value> --file <value>
FLAGS
--file=<value> (required) Build file.
--project-id=<value> (required) The ID of the project to upload the build file to.
DESCRIPTION
Upload the build file.
EXAMPLES
$ autify mobile api upload-build
See code: src/commands/mobile/api/upload-build.ts
Login to Autify for Mobile
USAGE
$ autify mobile auth login
DESCRIPTION
Login to Autify for Mobile
EXAMPLES
Start interactive setup:
$ autify mobile auth login
Reading the token from file:
$ autify mobile auth login < token.txt
See code: src/commands/mobile/auth/login.ts
Upload a build file
USAGE
$ autify mobile build upload BUILD-PATH -w <value> [--json]
ARGUMENTS
BUILD-PATH File path to the iOS app (*.app, *.ipa) or Android app (*.apk).
FLAGS
-w, --workspace-id=<value> (required) Workspace ID to upload the build file
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Upload a build file
EXAMPLES
$ autify mobile build upload
Upload build file
$ autify mobile build upload --workspace-id AAA ./my.app
Upload build file (JSON output)
$ autify mobile build upload --workspace-id AAA ./my.app --json
See code: src/commands/mobile/build/upload.ts
Run a test plan.
USAGE
$ autify mobile test run TEST-PLAN-URL [--build-id <value> | --build-path <value>] [-w] [-t <value>] [-v]
[--max-retry-count <value>]
ARGUMENTS
TEST-PLAN-URL Test plan URL e.g. https://mobile-app.autify.com/projects/<ID>/test_plans/<ID>
FLAGS
-t, --timeout=<value> [default: 300] Timeout seconds when waiting for the finish of the test execution.
-v, --verbose Verbose output
-w, --wait Wait until the test finishes.
--build-id=<value> ID of the already uploaded build.
--build-path=<value> File path to the iOS app (*.app, *.ipa) or Android app (*.apk).
--max-retry-count=<value> Maximum retry count. The command can take up to timeout * (max-retry-count + 1).
DESCRIPTION
Run a test plan.
EXAMPLES
Run a test plan with a build ID:
$ autify mobile test run --build-id CCC https://mobile-app.autify.com/projects/AAA/test_plans/BBB
Run a test plan with a new build file:
$ autify mobile test run --build-path ./my.[app|apk] https://mobile-app.autify.com/projects/AAA/test_plans/BBB
Run and wait a test plan:
$ autify mobile test run --build-id CCC https://mobile-app.autify.com/projects/AAA/test_plans/BBB --wait \
--timeout 600
See code: src/commands/mobile/test/run.ts
Wait a test result until it finishes.
USAGE
$ autify mobile test wait TEST-RESULT-URL [-t <value>] [-v]
ARGUMENTS
TEST-RESULT-URL Test result URL e.g. https://mobile-app.autify.com/projects/<ID>/results/<ID>
FLAGS
-t, --timeout=<value> [default: 300] Timeout seconds when waiting for the finish of the test execution.
-v, --verbose Verbose output
DESCRIPTION
Wait a test result until it finishes.
EXAMPLES
$ autify mobile test wait https://mobile-app.autify.com/projects/AAA/results/BBB
See code: src/commands/mobile/test/wait.ts
update the autify CLI
USAGE
$ autify update [CHANNEL] [--force | | [-a | -v <value> | -i]] [-b ]
FLAGS
-a, --available See available versions.
-b, --verbose Show more details about the available versions.
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
-v, --version=<value> Install a specific version.
--force Force a re-download of the requested version.
DESCRIPTION
update the autify CLI
EXAMPLES
Update to the stable channel:
$ autify update stable
Update to a specific version:
$ autify update --version 1.0.0
Interactively select version:
$ autify update --interactive
See available versions:
$ autify update --available
See code: @oclif/plugin-update
You can generate a new access point by passing in its name.
USAGE
$ autify web api create-access-point --project-id <value> --create-access-point-request <value>
FLAGS
--create-access-point-request=<value> (required) A JSON object with the name of the access point to be created e.g.
{"name":"string"}
--project-id=<value> (required) For example, 1 for the following URL:
https://app.autify.com/projects/1/scenarios
DESCRIPTION
You can generate a new access point by passing in its name.
EXAMPLES
$ autify web api create-access-point
See code: src/commands/web/api/create-access-point.ts
Create a new variable for the test plan
USAGE
$ autify web api create-test-plan-variable --test-plan-id <value> --create-test-plan-variable-request <value>
FLAGS
--create-test-plan-variable-request=<value> (required) A JSON object with the new variable key and default value to
use in the test plan e.g. {"key":"string","default_value":"string"}
--test-plan-id=<value> (required) For example, 15 for the following URL:
https://app.autify.com/projects/1/test_plans/15
DESCRIPTION
Create a new variable for the test plan
EXAMPLES
$ autify web api create-test-plan-variable
See code: src/commands/web/api/create-test-plan-variable.ts
Create a new url replacement for the test plan
USAGE
$ autify web api create-url-replacement --test-plan-id <value> --create-url-replacement-request <value>
FLAGS
--create-url-replacement-request=<value> (required) A JSON object with the url to replace e.g.
{"pattern_url":"string","replacement_url":"string"}
--test-plan-id=<value> (required) For example, 15 for the following URL:
https://app.autify.com/projects/1/test_plans/15
DESCRIPTION
Create a new url replacement for the test plan
EXAMPLES
$ autify web api create-url-replacement
See code: src/commands/web/api/create-url-replacement.ts
You can delete an access point by passing in its name.
USAGE
$ autify web api delete-access-point --project-id <value> --delete-access-point-request <value>
FLAGS
--delete-access-point-request=<value> (required) A JSON object with the name of the access point to be deleted e.g.
{"name":"string"}
--project-id=<value> (required) For example, 1 for the following URL:
https://app.autify.com/projects/1/scenarios
DESCRIPTION
You can delete an access point by passing in its name.
EXAMPLES
$ autify web api delete-access-point
See code: src/commands/web/api/delete-access-point.ts
Delete an existing test plan variable for the test plan
USAGE
$ autify web api delete-test-plan-variable --test-plan-id <value> --test-plan-variable-id <value>
FLAGS
--test-plan-id=<value> (required) For example, 15 for the following URL:
https://app.autify.com/projects/1/test_plans/15/
--test-plan-variable-id=<value> (required) test_plan_variable id
DESCRIPTION
Delete an existing test plan variable for the test plan
EXAMPLES
$ autify web api delete-test-plan-variable
See code: src/commands/web/api/delete-test-plan-variable.ts
Delete a url replacement for the test plan
USAGE
$ autify web api delete-url-replacement --test-plan-id <value> --url-replacement-id <value>
FLAGS
--test-plan-id=<value> (required) For example, 15 for the following URL:
https://app.autify.com/projects/1/test_plans/15
--url-replacement-id=<value> (required) url_replacement id
DESCRIPTION
Delete a url replacement for the test plan
EXAMPLES
$ autify web api delete-url-replacement
See code: src/commands/web/api/delete-url-replacement.ts
Get a test result.
USAGE
$ autify web api describe-result --project-id <value> --result-id <value> [--get-details <value>]
FLAGS
--get-details=<value> The flag to get details of the test case result.
--project-id=<value> (required) For example, 1 for the following URL: https://app.autify.com/projects/1/results/4
--result-id=<value> (required) For example, 4 for the following URL: https://app.autify.com/projects/1/results/4
DESCRIPTION
Get a test result.
EXAMPLES
$ autify web api describe-result
See code: src/commands/web/api/describe-result.ts
Get a scenario.
USAGE
$ autify web api describe-scenario --project-id <value> --scenario-id <value>
FLAGS
--project-id=<value> (required) For example, 1 for the following URL: https://app.autify.com/projects/1/scenarios/2
--scenario-id=<value> (required) For example, 2 for the following URL: https://app.autify.com/projects/1/scenarios/2
DESCRIPTION
Get a scenario.
EXAMPLES
$ autify web api describe-scenario
See code: src/commands/web/api/describe-scenario.ts
You can execute any scenarios in your workspace using any execution environments (which is called "capabilities" here).
USAGE
$ autify web api execute-scenarios --project-id <value> --execute-scenarios-request <value>
FLAGS
--execute-scenarios-request=<value>
(required) A JSON object with the scenarios and settings to execute e.g.
{"name":"string","execution_type":"parallel","capabilities":[{"os":"string","os_type":"macos","os_version":"string",
"device":"string","browser":"string","browser_type":"chrome","browser_version":"string"}],"url_replacements":[{"patt
ern_url":"string","replacement_url":"string"}],"scenarios":[{"id":0}],"autify_connect":{"name":"string"}}
--project-id=<value>
(required) For example, 1 for the following URL: https://app.autify.com/projects/1/scenarios
DESCRIPTION
You can execute any scenarios in your workspace using any execution environments (which is called "capabilities"
here).
EXAMPLES
$ autify web api execute-scenarios
See code: src/commands/web/api/execute-scenarios.ts
"Schedule" is called as "Test Plan" now. If you want to run a test plan, use this endpoint.
USAGE
$ autify web api execute-schedule --schedule-id <value> [--execute-schedule-request <value>]
FLAGS
--execute-schedule-request=<value> A JSON object with the options to execute a test plan. e.g.
{"autify_connect":{"name":"string"}}
--schedule-id=<value> (required) For example, 3 for the following URL:
https://app.autify.com/projects/1/test_plans/3
DESCRIPTION
"Schedule" is called as "Test Plan" now. If you want to run a test plan, use this endpoint.
EXAMPLES
$ autify web api execute-schedule
See code: src/commands/web/api/execute-schedule.ts
Get the number of credits used in the project Notes: This endpoint works only for organizations on credit-based plans. It always returns 0 for credits_consumed and credit_consumption_event_count if your organization is on a run-based plan.
USAGE
$ autify web api get-credit-usage --project-id <value> [--date-from <value>] [--date-to <value>] [--scenario-id <value>]
[--test-plan-id <value>] [--user-id <value>]
FLAGS
--date-from=<value> The date to start counting used credits from. If not specified, the date will be set to 1 week
ago. Up to 90 days in advance can be specified. If the specified date is more than 90 days in
the past, the date will be set to 90 days ago. Date must follow the format YYYY-MM-DD
(example: "2023-09-21").
--date-to=<value> The date to end counting used credits from. If not specified, the date will be set to today.
Date must follow the format YYYY-MM-DD (example: "2023-09-28").
--project-id=<value> (required) For example, 1 for the following URL: https://app.autify.com/projects/1/credits
--scenario-id=<value> The scenario ID to filter used credits by.
--test-plan-id=<value> The test plan ID to filter used credits by.
--user-id=<value> The user ID that executed tests to filter used credits by.
DESCRIPTION
Get the number of credits used in the project Notes: This endpoint works only for organizations on credit-based
plans. It always returns 0 for `credits_consumed` and `credit_consumption_event_count` if your organization is on a
run-based plan.
EXAMPLES
$ autify web api get-credit-usage
See code: src/commands/web/api/get-credit-usage.ts
Get project information.
USAGE
$ autify web api get-project-info --project-id <value>
FLAGS
--project-id=<value> (required) For example, 1 for the following URL: https://app.autify.com/projects/1/project_info
DESCRIPTION
Get project information.
EXAMPLES
$ autify web api get-project-info
See code: src/commands/web/api/get-project-info.ts
List access points for the project.
USAGE
$ autify web api list-access-points --project-id <value> [--page <value>]
FLAGS
--page=<value> The number of page returns.
--project-id=<value> (required) For example, 1 for the following URL: https://app.autify.com/projects/1/scenarios
DESCRIPTION
List access points for the project.
EXAMPLES
$ autify web api list-access-points
See code: src/commands/web/api/list-access-points.ts
List available Capabilities.
USAGE
$ autify web api list-capabilities --project-id <value> [--os <value>] [--os-type <value>] [--browser <value>]
[--browser-type <value>] [--device-type <value>]
FLAGS
--browser=<value> browser name to filter (deprecated)
--browser-type=<value> Type of the browser to filter
--device-type=<value> device_type name to filter (mobile is deprecated)
--os=<value> os name to filter (deprecated)
--os-type=<value> Type of the os to filter
--project-id=<value> (required) For example, 1 for the following URL:
https://app.autify.com/projects/1/capabilities
DESCRIPTION
List available Capabilities.
EXAMPLES
$ autify web api list-capabilities
See code: src/commands/web/api/list-capabilities.ts
List test results.
USAGE
$ autify web api list-results --project-id <value> [--page <value>] [--per-page <value>] [--test-plan-id <value>]
FLAGS
--page=<value> The number of page returns.
--per-page=<value> The number of items returns. Default number is 30 and up to a maximum of 100
--project-id=<value> (required) For example, 1 for the following URL: https://app.autify.com/projects/1/results
--test-plan-id=<value> Test plan ID used to filter results.
DESCRIPTION
List test results.
EXAMPLES
$ autify web api list-results
See code: src/commands/web/api/list-results.ts
List scenarios.
USAGE
$ autify web api list-scenarios --project-id <value> [--page <value>]
FLAGS
--page=<value> The number of page returns.
--project-id=<value> (required) For example, 1 for the following URL: https://app.autify.com/projects/1/scenarios
DESCRIPTION
List scenarios.
EXAMPLES
$ autify web api list-scenarios
See code: src/commands/web/api/list-scenarios.ts
List the test plan's variables
USAGE
$ autify web api list-test-plan-variable --test-plan-id <value>
FLAGS
--test-plan-id=<value> (required) For example, 15 for the following URL:
https://app.autify.com/projects/1/test_plans/15
DESCRIPTION
List the test plan's variables
EXAMPLES
$ autify web api list-test-plan-variable
See code: src/commands/web/api/list-test-plan-variable.ts
List url replacements for the test plan
USAGE
$ autify web api list-url-replacements --test-plan-id <value>
FLAGS
--test-plan-id=<value> (required) For example, 15 for the following URL:
https://app.autify.com/projects/1/test_plans/15
DESCRIPTION
List url replacements for the test plan
EXAMPLES
$ autify web api list-url-replacements
See code: src/commands/web/api/list-url-replacements.ts
Update a url replacement for the test plan
USAGE
$ autify web api update-test-plan-variable --test-plan-id <value> --test-plan-variable-id <value> --update-test-plan-variable-request
<value>
FLAGS
--test-plan-id=<value> (required) For example, 15 for the following URL:
https://app.autify.com/projects/1/test_plans/15
--test-plan-variable-id=<value> (required) test_plan_variable id
--update-test-plan-variable-request=<value> (required) A JSON object with the variable's new key and/or
default_value's value to register e.g.
{"key":"string","default_value":"string"}
DESCRIPTION
Update a url replacement for the test plan
EXAMPLES
$ autify web api update-test-plan-variable
See code: src/commands/web/api/update-test-plan-variable.ts
Update a url replacement for the test plan
USAGE
$ autify web api update-url-replacement --test-plan-id <value> --url-replacement-id <value> --update-url-replacement-request
<value>
FLAGS
--test-plan-id=<value> (required) For example, 15 for the following URL:
https://app.autify.com/projects/1/test_plans/15
--update-url-replacement-request=<value> (required) A JSON object with the url to replace. Either pattern_url or
replacement_url is required. e.g.
{"pattern_url":"string","replacement_url":"string"}
--url-replacement-id=<value> (required) url_replacement id
DESCRIPTION
Update a url replacement for the test plan
EXAMPLES
$ autify web api update-url-replacement
See code: src/commands/web/api/update-url-replacement.ts
Login to Autify for Web
USAGE
$ autify web auth login
DESCRIPTION
Login to Autify for Web
EXAMPLES
Start interactive setup:
$ autify web auth login
Reading the token from file:
$ autify web auth login < token.txt
See code: src/commands/web/auth/login.ts
Run a scenario or test plan.
USAGE
$ autify web test run SCENARIO-OR-TEST-PLAN-URL [-n <value>] [-r <value>...] [--autify-connect <value> |
--autify-connect-client] [--autify-connect-client-verbose ] [--autify-connect-client-file-logging ]
[--autify-connect-client-debug-server-port <value> ] [--autify-connect-client-extra-arguments <value> ] [--os
<value>] [--os-version <value>] [--browser <value>] [--device <value>] [--device-type <value>] [-w] [-t <value>]
[-v] [--max-retry-count <value>]
ARGUMENTS
SCENARIO-OR-TEST-PLAN-URL Scenario URL or Test plan URL e.g.
https://app.autify.com/projects/<ID>/(scenarios|test_plans)/<ID>
FLAGS
-n, --name=<value> [Only for test scenario] Name of the test execution.
-r, --url-replacements=<value>... URL replacements. Example: "http://example.com
http://example.net"
-t, --timeout=<value> [default: 300] Timeout seconds when waiting for the finish of
the test execution.
-v, --verbose Verbose output
-w, --wait Wait until the test finishes.
--autify-connect=<value> Name of the Autify Connect Access Point.
--autify-connect-client Start Autify Connect Client
--autify-connect-client-debug-server-port=<value> Port for Autify Connect Client debug server. A random port will
be used if not specified.
--autify-connect-client-extra-arguments=<value> Extra command line arguments you want to pass to Autify Connect
Client e.g. "--tunnel-proxy http://proxy".
--autify-connect-client-file-logging Logging Autify Connect Client log to a file instead of console.
--autify-connect-client-verbose Verbose output for Autify Connect Client.
--browser=<value> [Only for test scenario] Browser to run the test
--device=<value> [Only for test scenario] Device to run the test
--device-type=<value> [Only for test scenario] Device type to run the test
--max-retry-count=<value> Maximum retry count while waiting. The command can take up to
`timeout * (max-retry-count + 1)`. Only effective with
`--wait`.
--os=<value> [Only for test scenario] OS to run the test
--os-version=<value> [Only for test scenario] OS version to run the test
DESCRIPTION
Run a scenario or test plan.
EXAMPLES
Run a test scenario (Default capability):
$ autify web test run https://app.autify.com/projects/0000/scenarios/0000
Run a test plan:
$ autify web test run https://app.autify.com/projects/0000/test_plans/0000
Run and wait a test scenario:
$ autify web test run https://app.autify.com/projects/0000/scenarios/0000 --wait --timeout 600
Run a test scenario with a specific capability:
$ autify web test run https://app.autify.com/projects/0000/scenarios/0000 --os "Windows Server" --browser Edge
With URL replacements:
$ autify web test run https://app.autify.com/projects/0000/scenarios/0000 -r "http://example.com \
http://example.net" -r "http://example.org http://example.net"
Run a test with specifying the execution name:
$ autify web test run https://app.autify.com/projects/0000/scenarios/0000 --name "Sample execution"
Run a test scenario with Autify Connect:
$ autify web test run https://app.autify.com/projects/0000/scenarios/0000 --autify-connect NAME
Run a test scenario with Autify Connect Client:
$ autify web test run https://app.autify.com/projects/0000/scenarios/0000 --wait --autify-connect-client
See code: src/commands/web/test/run.ts
Wait a test result until it finishes.
USAGE
$ autify web test wait TEST-RESULT-URL [-t <value>] [-v]
ARGUMENTS
TEST-RESULT-URL Test result URL e.g. https://app.autify.com/projects/<ID>/results/<ID>
FLAGS
-t, --timeout=<value> [default: 300] Timeout seconds when waiting for the finish of the test execution.
-v, --verbose Verbose output
DESCRIPTION
Wait a test result until it finishes.
EXAMPLES
$ autify web test wait https://app.autify.com/projects/0000/results/0000
See code: src/commands/web/test/wait.ts