Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/autifyhq/autify-cli

Autify Command Line Interface (CLI)
https://github.com/autifyhq/autify-cli

autify cli

Last synced: about 2 months ago
JSON representation

Autify Command Line Interface (CLI)

Host: GitHub
URL: https://github.com/autifyhq/autify-cli
Owner: autifyhq
License: mit
Created: 2022-05-31T18:37:31.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-05-23T01:31:24.000Z (4 months ago)
Last Synced: 2024-05-23T03:11:01.010Z (4 months ago)
Topics: autify, cli
Language: TypeScript
Homepage: https://help.autify.com/docs/autify-command-line-interface
Size: 3.83 MB
Stars: 40
Watchers: 4
Forks: 1
Open Issues: 12
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Autify Command Line Interface (CLI)

![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/autifyhq/autify-cli?color=blue&display_name=tag&sort=semver) [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

Autify CLI can help your integration with Autify!

![Autify_CLI_ogp (2)](https://user-images.githubusercontent.com/37822/186738361-4d07c65f-9d3b-4295-ba3c-f2b84a6d9743.png)

- [Autify Command Line Interface (CLI)](#autify-command-line-interface-cli)
- [Usage](#usage)
- [Commands](#commands)

# Usage

See our official document: https://help.autify.com/docs/autify-command-line-interface

# Commands

- [`autify connect access-point create`](#autify-connect-access-point-create)
- [`autify connect access-point set`](#autify-connect-access-point-set)
- [`autify connect client install [VERSION]`](#autify-connect-client-install-version)
- [`autify connect client start`](#autify-connect-client-start)
- [`autify help [COMMAND]`](#autify-help-command)
- [`autify mobile api describe-test-result`](#autify-mobile-api-describe-test-result)
- [`autify mobile api list-test-results`](#autify-mobile-api-list-test-results)
- [`autify mobile api run-test-plan`](#autify-mobile-api-run-test-plan)
- [`autify mobile api upload-build`](#autify-mobile-api-upload-build)
- [`autify mobile auth login`](#autify-mobile-auth-login)
- [`autify mobile build upload BUILD-PATH`](#autify-mobile-build-upload-build-path)
- [`autify mobile test run TEST-PLAN-URL`](#autify-mobile-test-run-test-plan-url)
- [`autify mobile test wait TEST-RESULT-URL`](#autify-mobile-test-wait-test-result-url)
- [`autify update [CHANNEL]`](#autify-update-channel)
- [`autify web api create-access-point`](#autify-web-api-create-access-point)
- [`autify web api create-test-plan-variable`](#autify-web-api-create-test-plan-variable)
- [`autify web api create-url-replacement`](#autify-web-api-create-url-replacement)
- [`autify web api delete-access-point`](#autify-web-api-delete-access-point)
- [`autify web api delete-test-plan-variable`](#autify-web-api-delete-test-plan-variable)
- [`autify web api delete-url-replacement`](#autify-web-api-delete-url-replacement)
- [`autify web api describe-result`](#autify-web-api-describe-result)
- [`autify web api describe-scenario`](#autify-web-api-describe-scenario)
- [`autify web api execute-scenarios`](#autify-web-api-execute-scenarios)
- [`autify web api execute-schedule`](#autify-web-api-execute-schedule)
- [`autify web api get-credit-usage`](#autify-web-api-get-credit-usage)
- [`autify web api get-project-info`](#autify-web-api-get-project-info)
- [`autify web api list-access-points`](#autify-web-api-list-access-points)
- [`autify web api list-capabilities`](#autify-web-api-list-capabilities)
- [`autify web api list-results`](#autify-web-api-list-results)
- [`autify web api list-scenarios`](#autify-web-api-list-scenarios)
- [`autify web api list-test-plan-variable`](#autify-web-api-list-test-plan-variable)
- [`autify web api list-url-replacements`](#autify-web-api-list-url-replacements)
- [`autify web api update-test-plan-variable`](#autify-web-api-update-test-plan-variable)
- [`autify web api update-url-replacement`](#autify-web-api-update-url-replacement)
- [`autify web auth login`](#autify-web-auth-login)
- [`autify web test run SCENARIO-OR-TEST-PLAN-URL`](#autify-web-test-run-scenario-or-test-plan-url)
- [`autify web test wait TEST-RESULT-URL`](#autify-web-test-wait-test-result-url)

## `autify connect access-point create`

Create an Autify Connect Access Point

```
USAGE
$ autify connect access-point create --name [--web-workspace-id ]

FLAGS
--name= (required) Name of Autify Connect Access Point to be created
--web-workspace-id= 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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/connect/access-point/create.ts)_

## `autify connect access-point set`

Set Autify Connect Access Point

```
USAGE
$ autify connect access-point set --name

FLAGS
--name= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/connect/access-point/set.ts)_

## `autify connect client install [VERSION]`

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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/connect/client/install.ts)_

## `autify connect client start`

Start Autify Connect Client

```
USAGE
$ autify connect client start [--verbose] [--file-logging] [--debug-server-port ] [--web-workspace-id ]
[--extra-arguments ]

FLAGS
--debug-server-port= 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= 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= 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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/connect/client/start.ts)_

## `autify help [COMMAND]`

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](https://github.com/oclif/plugin-help/blob/v6.2.4/src/commands/help.ts)_

## `autify mobile api describe-test-result`

Get a test result.

```
USAGE
$ autify mobile api describe-test-result --project-id --id

FLAGS
--id= (required) Test Result ID.
--project-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/mobile/api/describe-test-result.ts)_

## `autify mobile api list-test-results`

List test results.

```
USAGE
$ autify mobile api list-test-results --project-id [--page ] [--per-page ] [--test-plan-id
]

FLAGS
--page= Page number to be retrieved.
--per-page= Number of test results per page.
--project-id= (required) ID of the project from which the list of test results will be retrieved.
--test-plan-id= 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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/mobile/api/list-test-results.ts)_

## `autify mobile api run-test-plan`

Run a test plan

```
USAGE
$ autify mobile api run-test-plan --test-plan-id --run-test-plan-request

FLAGS
--run-test-plan-request= (required) The build_id to execute the test plan.
--test-plan-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/mobile/api/run-test-plan.ts)_

## `autify mobile api upload-build`

Upload the build file.

```
USAGE
$ autify mobile api upload-build --project-id --file

FLAGS
--file= (required) Build file.
--project-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/mobile/api/upload-build.ts)_

## `autify mobile auth login`

```
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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/mobile/auth/login.ts)_

## `autify mobile build upload BUILD-PATH`

Upload a build file

```
USAGE
$ autify mobile build upload BUILD-PATH -w [--json]

ARGUMENTS
BUILD-PATH File path to the iOS app (*.app) or Android app (*.apk).

FLAGS
-w, --workspace-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/mobile/build/upload.ts)_

## `autify mobile test run TEST-PLAN-URL`

Run a test plan.

```
USAGE
$ autify mobile test run TEST-PLAN-URL [--build-id | --build-path ] [-w] [-t ] [-v]
[--max-retry-count ]

ARGUMENTS
TEST-PLAN-URL Test plan URL e.g. https://mobile-app.autify.com/projects//test_plans/

FLAGS
-t, --timeout= [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= ID of the already uploaded build.
--build-path= File path to the iOS app (*.app) or Android app (*.apk).
--max-retry-count= 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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/mobile/test/run.ts)_

## `autify mobile test wait TEST-RESULT-URL`

Wait a test result until it finishes.

```
USAGE
$ autify mobile test wait TEST-RESULT-URL [-t ] [-v]

ARGUMENTS
TEST-RESULT-URL Test result URL e.g. https://mobile-app.autify.com/projects//results/

FLAGS
-t, --timeout= [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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/mobile/test/wait.ts)_

## `autify update [CHANNEL]`

update the autify CLI

```
USAGE
$ autify update [CHANNEL] [--force | | [-a | -v | -i]]

FLAGS
-a, --available See available versions.
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
-v, --version= 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](https://github.com/oclif/plugin-update/blob/v4.4.6/src/commands/update.ts)_

## `autify web api create-access-point`

You can generate a new access point by passing in its name.

```
USAGE
$ autify web api create-access-point --project-id --create-access-point-request

FLAGS
--create-access-point-request= (required) The name of the access point to be created
--project-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/api/create-access-point.ts)_

## `autify web api create-test-plan-variable`

Create a new variable for the test plan

```
USAGE
$ autify web api create-test-plan-variable --test-plan-id --create-test-plan-variable-request

FLAGS
--create-test-plan-variable-request= (required) The new variable key and default value to use in the test plan
--test-plan-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/api/create-test-plan-variable.ts)_

## `autify web api create-url-replacement`

Create a new url replacement for the test plan

```
USAGE
$ autify web api create-url-replacement --test-plan-id --create-url-replacement-request

FLAGS
--create-url-replacement-request= (required) The url to replace
--test-plan-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/api/create-url-replacement.ts)_

## `autify web api delete-access-point`

You can delete an access point by passing in its name.

```
USAGE
$ autify web api delete-access-point --project-id --delete-access-point-request

FLAGS
--delete-access-point-request= (required) The name of the access point to be deleted
--project-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/api/delete-access-point.ts)_

## `autify web api delete-test-plan-variable`

Delete an existing test plan variable for the test plan

```
USAGE
$ autify web api delete-test-plan-variable --test-plan-id --test-plan-variable-id

FLAGS
--test-plan-id= (required) For example, 15 for the following URL:
https://app.autify.com/projects/1/test_plans/15/
--test-plan-variable-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/api/delete-test-plan-variable.ts)_

## `autify web api delete-url-replacement`

Delete a url replacement for the test plan

```
USAGE
$ autify web api delete-url-replacement --test-plan-id --url-replacement-id

FLAGS
--test-plan-id= (required) For example, 15 for the following URL:
https://app.autify.com/projects/1/test_plans/15
--url-replacement-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/api/delete-url-replacement.ts)_

## `autify web api describe-result`

Get a test result.

```
USAGE
$ autify web api describe-result --project-id --result-id [--get-details ]

FLAGS
--get-details= The flag to get details of the test case result.
--project-id= (required) For example, 1 for the following URL: https://app.autify.com/projects/1/results/4
--result-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/api/describe-result.ts)_

## `autify web api describe-scenario`

Get a scenario.

```
USAGE
$ autify web api describe-scenario --project-id --scenario-id

FLAGS
--project-id= (required) For example, 1 for the following URL: https://app.autify.com/projects/1/scenarios/2
--scenario-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/api/describe-scenario.ts)_

## `autify web api execute-scenarios`

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 --execute-scenarios-request

FLAGS
--execute-scenarios-request= (required) The scenarios and settings to execute
--project-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/api/execute-scenarios.ts)_

## `autify web api execute-schedule`

"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 [--execute-schedule-request ]

FLAGS
--execute-schedule-request= The options to execute a test plan.
--schedule-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/api/execute-schedule.ts)_

## `autify web api get-credit-usage`

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 [--date-from ] [--date-to ] [--scenario-id ]
[--test-plan-id ] [--user-id ]

FLAGS
--date-from= 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= 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= (required) For example, 1 for the following URL: https://app.autify.com/projects/1/credits
--scenario-id= The scenario ID to filter used credits by.
--test-plan-id= The test plan ID to filter used credits by.
--user-id= 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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/api/get-credit-usage.ts)_

## `autify web api get-project-info`

Get project information.

```
USAGE
$ autify web api get-project-info --project-id

FLAGS
--project-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/api/get-project-info.ts)_

## `autify web api list-access-points`

List access points for the project.

```
USAGE
$ autify web api list-access-points --project-id [--page ]

FLAGS
--page= The number of page returns.
--project-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/api/list-access-points.ts)_

## `autify web api list-capabilities`

List available Capabilities.

```
USAGE
$ autify web api list-capabilities --project-id [--os ] [--browser ] [--device-type ]

FLAGS
--browser= browser name to filter
--device-type= device_type name to filter
--os= os name to filter
--project-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/api/list-capabilities.ts)_

## `autify web api list-results`

List test results.

```
USAGE
$ autify web api list-results --project-id [--page ] [--per-page ] [--test-plan-id ]

FLAGS
--page= The number of page returns.
--per-page= The number of items returns. Default number is 30 and up to a maximum of 100
--project-id= (required) For example, 1 for the following URL: https://app.autify.com/projects/1/results
--test-plan-id= 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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/api/list-results.ts)_

## `autify web api list-scenarios`

List scenarios.

```
USAGE
$ autify web api list-scenarios --project-id [--page ]

FLAGS
--page= The number of page returns.
--project-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/api/list-scenarios.ts)_

## `autify web api list-test-plan-variable`

List the test plan's variables

```
USAGE
$ autify web api list-test-plan-variable --test-plan-id

FLAGS
--test-plan-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/api/list-test-plan-variable.ts)_

## `autify web api list-url-replacements`

List url replacements for the test plan

```
USAGE
$ autify web api list-url-replacements --test-plan-id

FLAGS
--test-plan-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/api/list-url-replacements.ts)_

## `autify web api update-test-plan-variable`

Update a url replacement for the test plan

```
USAGE
$ autify web api update-test-plan-variable --test-plan-id --test-plan-variable-id --update-test-plan-variable-request

FLAGS
--test-plan-id= (required) For example, 15 for the following URL:
https://app.autify.com/projects/1/test_plans/15
--test-plan-variable-id= (required) test_plan_variable id
--update-test-plan-variable-request= (required) The variable's new key and/or default_value's value to
register

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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/api/update-test-plan-variable.ts)_

## `autify web api update-url-replacement`

Update a url replacement for the test plan

```
USAGE
$ autify web api update-url-replacement --test-plan-id --url-replacement-id --update-url-replacement-request

FLAGS
--test-plan-id= (required) For example, 15 for the following URL:
https://app.autify.com/projects/1/test_plans/15
--update-url-replacement-request= (required) The url to replace. Either pattern_url or replacement_url is
required.
--url-replacement-id= (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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/api/update-url-replacement.ts)_

## `autify web auth login`

```
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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/auth/login.ts)_

## `autify web test run SCENARIO-OR-TEST-PLAN-URL`

Run a scenario or test plan.

```
USAGE
$ autify web test run SCENARIO-OR-TEST-PLAN-URL [-n ] [-r ...] [--autify-connect |
--autify-connect-client] [--autify-connect-client-verbose ] [--autify-connect-client-file-logging ]
[--autify-connect-client-debug-server-port ] [--autify-connect-client-extra-arguments ] [--os
] [--os-version ] [--browser ] [--device ] [--device-type ] [-w] [-t ]
[-v] [--max-retry-count ]

ARGUMENTS
SCENARIO-OR-TEST-PLAN-URL Scenario URL or Test plan URL e.g.
https://app.autify.com/projects//(scenarios|test_plans)/

FLAGS
-n, --name= [Only for test scenario] Name of the test execution.
-r, --url-replacements=... URL replacements. Example: "http://example.com
http://example.net"
-t, --timeout= [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= Name of the Autify Connect Access Point.
--autify-connect-client Start Autify Connect Client
--autify-connect-client-debug-server-port= Port for Autify Connect Client debug server. A random port will
be used if not specified.
--autify-connect-client-extra-arguments= 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= [Only for test scenario] Browser to run the test
--device= [Only for test scenario] Device to run the test
--device-type= [Only for test scenario] Device type to run the test
--max-retry-count= Maximum retry count while waiting. The command can take up to
`timeout * (max-retry-count + 1)`. Only effective with
`--wait`.
--os= [Only for test scenario] OS to run the test
--os-version= [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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/test/run.ts)_

## `autify web test wait TEST-RESULT-URL`

Wait a test result until it finishes.

```
USAGE
$ autify web test wait TEST-RESULT-URL [-t ] [-v]

ARGUMENTS
TEST-RESULT-URL Test result URL e.g. https://app.autify.com/projects//results/

FLAGS
-t, --timeout= [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](https://github.com/autifyhq/autify-cli/blob/v0.47.0-beta.0/src/commands/web/test/wait.ts)_