{"id":13475396,"url":"https://github.com/autifyhq/autify-cli","last_synced_at":"2026-02-03T05:09:16.969Z","repository":{"id":36962937,"uuid":"498455295","full_name":"autifyhq/autify-cli","owner":"autifyhq","description":"Autify Command Line Interface (CLI)","archived":false,"fork":false,"pushed_at":"2025-03-21T22:26:22.000Z","size":5109,"stargazers_count":40,"open_issues_count":10,"forks_count":4,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-03-22T12:04:24.201Z","etag":null,"topics":["autify","cli"],"latest_commit_sha":null,"homepage":"https://help.autify.com/docs/autify-command-line-interface","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/autifyhq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-31T18:37:31.000Z","updated_at":"2025-03-21T07:58:21.000Z","dependencies_parsed_at":"2024-01-27T23:28:12.624Z","dependency_job_id":"6809d5cc-f08e-45f1-b58b-d98dec409433","html_url":"https://github.com/autifyhq/autify-cli","commit_stats":{"total_commits":401,"total_committers":14,"mean_commits":"28.642857142857142","dds":0.743142144638404,"last_synced_commit":"da8daa0920930e633d68ef64cf821858e457c131"},"previous_names":[],"tags_count":55,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/autifyhq%2Fautify-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/autifyhq%2Fautify-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/autifyhq%2Fautify-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/autifyhq%2Fautify-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/autifyhq","download_url":"https://codeload.github.com/autifyhq/autify-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245760706,"owners_count":20667886,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["autify","cli"],"created_at":"2024-07-31T16:01:20.053Z","updated_at":"2026-02-03T05:09:16.952Z","avatar_url":"https://github.com/autifyhq.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Autify Command Line Interface (CLI)\n\n![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/autifyhq/autify-cli?color=blue\u0026display_name=tag\u0026sort=semver) [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)\n\nAutify CLI can help your integration with Autify!\n\n![Autify_CLI_ogp (2)](https://user-images.githubusercontent.com/37822/186738361-4d07c65f-9d3b-4295-ba3c-f2b84a6d9743.png)\n\n\u003c!-- toc --\u003e\n\n- [Autify Command Line Interface (CLI)](#autify-command-line-interface-cli)\n- [Usage](#usage)\n- [Commands](#commands)\n\u003c!-- tocstop --\u003e\n\n# Usage\n\nSee our official document: https://help.autify.com/docs/autify-command-line-interface\n\n# Commands\n\n\u003c!-- commands --\u003e\n\n- [`autify connect access-point create`](#autify-connect-access-point-create)\n- [`autify connect access-point set`](#autify-connect-access-point-set)\n- [`autify connect client install [VERSION]`](#autify-connect-client-install-version)\n- [`autify connect client start`](#autify-connect-client-start)\n- [`autify help [COMMAND]`](#autify-help-command)\n- [`autify mobile api describe-test-result`](#autify-mobile-api-describe-test-result)\n- [`autify mobile api list-test-results`](#autify-mobile-api-list-test-results)\n- [`autify mobile api run-test-plan`](#autify-mobile-api-run-test-plan)\n- [`autify mobile api upload-build`](#autify-mobile-api-upload-build)\n- [`autify mobile auth login`](#autify-mobile-auth-login)\n- [`autify mobile build upload BUILD-PATH`](#autify-mobile-build-upload-build-path)\n- [`autify mobile link doctor`](#autify-mobile-link-doctor)\n- [`autify mobile link exec [THINGS]`](#autify-mobile-link-exec-things)\n- [`autify mobile link install`](#autify-mobile-link-install)\n- [`autify mobile link setup`](#autify-mobile-link-setup)\n- [`autify mobile link start [WORKSPACEID]`](#autify-mobile-link-start-workspaceid)\n- [`autify mobile test run TEST-PLAN-URL`](#autify-mobile-test-run-test-plan-url)\n- [`autify mobile test wait TEST-RESULT-URL`](#autify-mobile-test-wait-test-result-url)\n- [`autify update [CHANNEL]`](#autify-update-channel)\n- [`autify web api create-access-point`](#autify-web-api-create-access-point)\n- [`autify web api create-test-plan-variable`](#autify-web-api-create-test-plan-variable)\n- [`autify web api create-url-replacement`](#autify-web-api-create-url-replacement)\n- [`autify web api delete-access-point`](#autify-web-api-delete-access-point)\n- [`autify web api delete-test-plan-variable`](#autify-web-api-delete-test-plan-variable)\n- [`autify web api delete-url-replacement`](#autify-web-api-delete-url-replacement)\n- [`autify web api describe-result`](#autify-web-api-describe-result)\n- [`autify web api describe-scenario`](#autify-web-api-describe-scenario)\n- [`autify web api execute-scenarios`](#autify-web-api-execute-scenarios)\n- [`autify web api execute-schedule`](#autify-web-api-execute-schedule)\n- [`autify web api get-credit-usage`](#autify-web-api-get-credit-usage)\n- [`autify web api get-project-info`](#autify-web-api-get-project-info)\n- [`autify web api list-access-points`](#autify-web-api-list-access-points)\n- [`autify web api list-capabilities`](#autify-web-api-list-capabilities)\n- [`autify web api list-results`](#autify-web-api-list-results)\n- [`autify web api list-scenarios`](#autify-web-api-list-scenarios)\n- [`autify web api list-test-plan-variable`](#autify-web-api-list-test-plan-variable)\n- [`autify web api list-url-replacements`](#autify-web-api-list-url-replacements)\n- [`autify web api update-test-plan-variable`](#autify-web-api-update-test-plan-variable)\n- [`autify web api update-url-replacement`](#autify-web-api-update-url-replacement)\n- [`autify web auth login`](#autify-web-auth-login)\n- [`autify web test run SCENARIO-OR-TEST-PLAN-URL`](#autify-web-test-run-scenario-or-test-plan-url)\n- [`autify web test wait TEST-RESULT-URL`](#autify-web-test-wait-test-result-url)\n\n## `autify connect access-point create`\n\nCreate an Autify Connect Access Point\n\n```\nUSAGE\n  $ autify connect access-point create --name \u003cvalue\u003e [--web-workspace-id \u003cvalue\u003e]\n\nFLAGS\n  --name=\u003cvalue\u003e              (required) Name of Autify Connect Access Point to be created\n  --web-workspace-id=\u003cvalue\u003e  Workspace ID of Autify for Web to which the Access Point will belong\n\nDESCRIPTION\n  Create an Autify Connect Access Point\n\nEXAMPLES\n  $ autify connect access-point create --name NAME --web-workspace-id ID\n```\n\n_See code: [src/commands/connect/access-point/create.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/connect/access-point/create.ts)_\n\n## `autify connect access-point set`\n\nSet Autify Connect Access Point\n\n```\nUSAGE\n  $ autify connect access-point set --name \u003cvalue\u003e\n\nFLAGS\n  --name=\u003cvalue\u003e  (required) Name of the Autify Connect Access Point already created\n\nDESCRIPTION\n  Set Autify Connect Access Point\n\nEXAMPLES\n  Start interactive setup:\n\n    $ autify connect access-point set --name=NAME\n\n  Reading the key from file:\n\n    $ autify connect access-point set --name=NAME \u003c key.txt\n```\n\n_See code: [src/commands/connect/access-point/set.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/connect/access-point/set.ts)_\n\n## `autify connect client install [VERSION]`\n\nInstall Autify Connect Client\n\n```\nUSAGE\n  $ autify connect client install [VERSION]\n\nARGUMENTS\n  [VERSION]  [default: v1.1.34] Specify the target version of Autify Connect Client.\n\nDESCRIPTION\n  Install Autify Connect Client\n\nEXAMPLES\n  (Recommended) Install the supported version:\n\n    $ autify connect client install\n\n  Install a specific version:\n\n    $ autify connect client install v0.6.1\n\n  Install a stable version:\n\n    $ autify connect client install stable\n```\n\n_See code: [src/commands/connect/client/install.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/connect/client/install.ts)_\n\n## `autify connect client start`\n\nStart Autify Connect Client\n\n```\nUSAGE\n  $ autify connect client start [--verbose] [--file-logging] [--debug-server-port \u003cvalue\u003e] [--web-workspace-id \u003cvalue\u003e]\n    [--extra-arguments \u003cvalue\u003e]\n\nFLAGS\n  --debug-server-port=\u003cvalue\u003e  The server for debugging and monitoring launches on your local machine on the given port.\n                               It will use a radom port if not specified.\n  --extra-arguments=\u003cvalue\u003e    Extra command line arguments you want to pass to Autify Connect Client e.g.\n                               \"--tunnel-proxy http://proxy\".\n  --file-logging               Logging Autify Connect Client log to a file instead of console.\n  --verbose                    Make the operation more talkative.\n  --web-workspace-id=\u003cvalue\u003e   Workspace ID of Autify for Web to create an ephemeral Access Point. If not specified, it\n                               will use the one configured by `autify connect access-point create/set`, instead.\n\nDESCRIPTION\n  Start Autify Connect Client\n\nEXAMPLES\n  With pre-created Access Point:\n\n    $ autify connect client start\n\n  With ephemeral Access Point of Autify for Web:\n\n    $ autify connect client start --web-workspace-id 000\n```\n\n_See code: [src/commands/connect/client/start.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/connect/client/start.ts)_\n\n## `autify help [COMMAND]`\n\nDisplay help for autify.\n\n```\nUSAGE\n  $ autify help [COMMAND...] [-n]\n\nARGUMENTS\n  [COMMAND...]  Command to show help for.\n\nFLAGS\n  -n, --nested-commands  Include all nested commands in the output.\n\nDESCRIPTION\n  Display help for autify.\n```\n\n_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.36/src/commands/help.ts)_\n\n## `autify mobile api describe-test-result`\n\nGet a test result.\n\n```\nUSAGE\n  $ autify mobile api describe-test-result --project-id \u003cvalue\u003e --id \u003cvalue\u003e\n\nFLAGS\n  --id=\u003cvalue\u003e          (required) Test Result ID.\n  --project-id=\u003cvalue\u003e  (required) ID of the project from which the test results will be obtained.\n\nDESCRIPTION\n  Get a test result.\n\nEXAMPLES\n  $ autify mobile api describe-test-result\n```\n\n_See code: [src/commands/mobile/api/describe-test-result.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/mobile/api/describe-test-result.ts)_\n\n## `autify mobile api list-test-results`\n\nList test results.\n\n```\nUSAGE\n  $ autify mobile api list-test-results --project-id \u003cvalue\u003e [--page \u003cvalue\u003e] [--per-page \u003cvalue\u003e] [--test-plan-id\n  \u003cvalue\u003e]\n\nFLAGS\n  --page=\u003cvalue\u003e          Page number to be retrieved.\n  --per-page=\u003cvalue\u003e      Number of test results per page.\n  --project-id=\u003cvalue\u003e    (required) ID of the project from which the list of test results will be retrieved.\n  --test-plan-id=\u003cvalue\u003e  ID of the test plan.\n\nDESCRIPTION\n  List test results.\n\nEXAMPLES\n  $ autify mobile api list-test-results\n```\n\n_See code: [src/commands/mobile/api/list-test-results.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/mobile/api/list-test-results.ts)_\n\n## `autify mobile api run-test-plan`\n\nRun a test plan\n\n```\nUSAGE\n  $ autify mobile api run-test-plan --test-plan-id \u003cvalue\u003e --run-test-plan-request \u003cvalue\u003e\n\nFLAGS\n  --run-test-plan-request=\u003cvalue\u003e  (required) A JSON object with the build_id to execute the test plan. e.g.\n                                   {\"build_id\":\"string\"}\n  --test-plan-id=\u003cvalue\u003e           (required) The ID of the test plan to run.\n\nDESCRIPTION\n  Run a test plan\n\nEXAMPLES\n  $ autify mobile api run-test-plan\n```\n\n_See code: [src/commands/mobile/api/run-test-plan.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/mobile/api/run-test-plan.ts)_\n\n## `autify mobile api upload-build`\n\nUpload the build file.\n\n```\nUSAGE\n  $ autify mobile api upload-build --project-id \u003cvalue\u003e --file \u003cvalue\u003e\n\nFLAGS\n  --file=\u003cvalue\u003e        (required) Build file.\n  --project-id=\u003cvalue\u003e  (required) The ID of the project to upload the build file to.\n\nDESCRIPTION\n  Upload the build file.\n\nEXAMPLES\n  $ autify mobile api upload-build\n```\n\n_See code: [src/commands/mobile/api/upload-build.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/mobile/api/upload-build.ts)_\n\n## `autify mobile auth login`\n\nLogin to Autify for Mobile\n\n```\nUSAGE\n  $ autify mobile auth login\n\nDESCRIPTION\n  Login to Autify for Mobile\n\nEXAMPLES\n  Start interactive setup:\n\n    $ autify mobile auth login\n\n  Reading the token from file:\n\n    $ autify mobile auth login \u003c token.txt\n```\n\n_See code: [src/commands/mobile/auth/login.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/mobile/auth/login.ts)_\n\n## `autify mobile build upload BUILD-PATH`\n\nUpload a build file\n\n```\nUSAGE\n  $ autify mobile build upload BUILD-PATH -w \u003cvalue\u003e [--json]\n\nARGUMENTS\n  BUILD-PATH  File path to the iOS app (*.app, *.ipa) or Android app (*.apk).\n\nFLAGS\n  -w, --workspace-id=\u003cvalue\u003e  (required) Workspace ID to upload the build file\n\nGLOBAL FLAGS\n  --json  Format output as json.\n\nDESCRIPTION\n  Upload a build file\n\nEXAMPLES\n  $ autify mobile build upload\n\n  Upload build file\n\n    $ autify mobile build upload --workspace-id AAA ./my.app\n\n  Upload build file (JSON output)\n\n    $ autify mobile build upload --workspace-id AAA ./my.app --json\n```\n\n_See code: [src/commands/mobile/build/upload.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/mobile/build/upload.ts)_\n\n## `autify mobile link doctor`\n\nCheck MobileLink configuration\n\n```\nUSAGE\n  $ autify mobile link doctor\n\nDESCRIPTION\n  Check MobileLink configuration\n\nEXAMPLES\n  Check MobileLink configuration:\n\n    $ autify mobile link doctor\n```\n\n_See code: [src/commands/mobile/link/doctor.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/mobile/link/doctor.ts)_\n\n## `autify mobile link exec [THINGS]`\n\nExecute arbitrary MobileLink subcommand\n\n```\nUSAGE\n  $ autify mobile link exec [THINGS...]\n\nDESCRIPTION\n  Execute arbitrary MobileLink subcommand\n\nEXAMPLES\n  Pass subcommand arguments to mobilelink:\n\n    $ autify mobile link exec ABC XYZ\n```\n\n_See code: [src/commands/mobile/link/exec.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/mobile/link/exec.ts)_\n\n## `autify mobile link install`\n\nInstall MobileLink\n\n```\nUSAGE\n  $ autify mobile link install\n\nDESCRIPTION\n  Install MobileLink\n\nEXAMPLES\n  Install the stable version:\n\n    $ autify mobile link install\n```\n\n_See code: [src/commands/mobile/link/install.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/mobile/link/install.ts)_\n\n## `autify mobile link setup`\n\nSet up MobileLink\n\n```\nUSAGE\n  $ autify mobile link setup\n\nDESCRIPTION\n  Set up MobileLink\n\nEXAMPLES\n  Set up MobileLink configuration:\n\n    $ autify mobile link setup\n```\n\n_See code: [src/commands/mobile/link/setup.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/mobile/link/setup.ts)_\n\n## `autify mobile link start [WORKSPACEID]`\n\nStart MobileLink session\n\n```\nUSAGE\n  $ autify mobile link start [WORKSPACEID...]\n\nARGUMENTS\n  [WORKSPACEID...]  Specify the target version of Autify Connect Client.\n\nDESCRIPTION\n  Start MobileLink session\n\nEXAMPLES\n  Pass subcommand arguments to mobilelink:\n\n    $ autify mobile link start ABC XYZ\n```\n\n_See code: [src/commands/mobile/link/start.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/mobile/link/start.ts)_\n\n## `autify mobile test run TEST-PLAN-URL`\n\nRun a test plan.\n\n```\nUSAGE\n  $ autify mobile test run TEST-PLAN-URL [--build-id \u003cvalue\u003e | --build-path \u003cvalue\u003e] [--device-ids \u003cvalue\u003e] [-w] [-t\n    \u003cvalue\u003e] [-v] [--max-retry-count \u003cvalue\u003e]\n\nARGUMENTS\n  TEST-PLAN-URL  Test plan URL e.g. https://mobile-app.autify.com/projects/\u003cID\u003e/test_plans/\u003cID\u003e\n\nFLAGS\n  -t, --timeout=\u003cvalue\u003e          [default: 300] Timeout seconds when waiting for the finish of the test execution.\n  -v, --verbose                  Verbose output\n  -w, --wait                     Wait until the test finishes.\n      --build-id=\u003cvalue\u003e         ID of the already uploaded build.\n      --build-path=\u003cvalue\u003e       File path to the iOS app (*.app, *.ipa) or Android app (*.apk).\n      --device-ids=\u003cvalue\u003e       Comma-separated device IDs to run the test plan.\n      --max-retry-count=\u003cvalue\u003e  Maximum retry count. The command can take up to timeout * (max-retry-count + 1).\n\nDESCRIPTION\n  Run a test plan.\n\nEXAMPLES\n  Run a test plan with a build ID:\n\n    $ autify mobile test run --build-id CCC https://mobile-app.autify.com/projects/AAA/test_plans/BBB\n\n  Run a test plan with a new build file:\n\n    $ autify mobile test run --build-path ./my.[app|apk] https://mobile-app.autify.com/projects/AAA/test_plans/BBB\n\n  Run and wait a test plan:\n\n    $ autify mobile test run --build-id CCC https://mobile-app.autify.com/projects/AAA/test_plans/BBB --wait \\\n      --timeout 600\n```\n\n_See code: [src/commands/mobile/test/run.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/mobile/test/run.ts)_\n\n## `autify mobile test wait TEST-RESULT-URL`\n\nWait a test result until it finishes.\n\n```\nUSAGE\n  $ autify mobile test wait TEST-RESULT-URL [-t \u003cvalue\u003e] [-v]\n\nARGUMENTS\n  TEST-RESULT-URL  Test result URL e.g. https://mobile-app.autify.com/projects/\u003cID\u003e/results/\u003cID\u003e\n\nFLAGS\n  -t, --timeout=\u003cvalue\u003e  [default: 300] Timeout seconds when waiting for the finish of the test execution.\n  -v, --verbose          Verbose output\n\nDESCRIPTION\n  Wait a test result until it finishes.\n\nEXAMPLES\n  $ autify mobile test wait https://mobile-app.autify.com/projects/AAA/results/BBB\n```\n\n_See code: [src/commands/mobile/test/wait.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/mobile/test/wait.ts)_\n\n## `autify update [CHANNEL]`\n\nupdate the autify CLI\n\n```\nUSAGE\n  $ autify update [CHANNEL] [--force |  | [-a | -v \u003cvalue\u003e | -i]] [-b ]\n\nFLAGS\n  -a, --available        See available versions.\n  -b, --verbose          Show more details about the available versions.\n  -i, --interactive      Interactively select version to install. This is ignored if a channel is provided.\n  -v, --version=\u003cvalue\u003e  Install a specific version.\n      --force            Force a re-download of the requested version.\n\nDESCRIPTION\n  update the autify CLI\n\nEXAMPLES\n  Update to the stable channel:\n\n    $ autify update stable\n\n  Update to a specific version:\n\n    $ autify update --version 1.0.0\n\n  Interactively select version:\n\n    $ autify update --interactive\n\n  See available versions:\n\n    $ autify update --available\n```\n\n_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v4.7.16/src/commands/update.ts)_\n\n## `autify web api create-access-point`\n\nYou can generate a new access point by passing in its name.\n\n```\nUSAGE\n  $ autify web api create-access-point --project-id \u003cvalue\u003e --create-access-point-request \u003cvalue\u003e\n\nFLAGS\n  --create-access-point-request=\u003cvalue\u003e  (required) A JSON object with the name of the access point to be created e.g.\n                                         {\"name\":\"string\"}\n  --project-id=\u003cvalue\u003e                   (required) For example, 1 for the following URL:\n                                         https://app.autify.com/projects/1/scenarios\n\nDESCRIPTION\n  You can generate a new access point by passing in its name.\n\nEXAMPLES\n  $ autify web api create-access-point\n```\n\n_See code: [src/commands/web/api/create-access-point.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/api/create-access-point.ts)_\n\n## `autify web api create-test-plan-variable`\n\nCreate a new variable for the test plan\n\n```\nUSAGE\n  $ autify web api create-test-plan-variable --test-plan-id \u003cvalue\u003e --create-test-plan-variable-request \u003cvalue\u003e\n\nFLAGS\n  --create-test-plan-variable-request=\u003cvalue\u003e  (required) A JSON object with the new variable key and default value to\n                                               use in the test plan e.g. {\"key\":\"string\",\"default_value\":\"string\"}\n  --test-plan-id=\u003cvalue\u003e                       (required) For example, 15 for the following URL:\n                                               https://app.autify.com/projects/1/test_plans/15\n\nDESCRIPTION\n  Create a new variable for the test plan\n\nEXAMPLES\n  $ autify web api create-test-plan-variable\n```\n\n_See code: [src/commands/web/api/create-test-plan-variable.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/api/create-test-plan-variable.ts)_\n\n## `autify web api create-url-replacement`\n\nCreate a new url replacement for the test plan\n\n```\nUSAGE\n  $ autify web api create-url-replacement --test-plan-id \u003cvalue\u003e --create-url-replacement-request \u003cvalue\u003e\n\nFLAGS\n  --create-url-replacement-request=\u003cvalue\u003e  (required) A JSON object with the url to replace e.g.\n                                            {\"pattern_url\":\"string\",\"replacement_url\":\"string\"}\n  --test-plan-id=\u003cvalue\u003e                    (required) For example, 15 for the following URL:\n                                            https://app.autify.com/projects/1/test_plans/15\n\nDESCRIPTION\n  Create a new url replacement for the test plan\n\nEXAMPLES\n  $ autify web api create-url-replacement\n```\n\n_See code: [src/commands/web/api/create-url-replacement.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/api/create-url-replacement.ts)_\n\n## `autify web api delete-access-point`\n\nYou can delete an access point by passing in its name.\n\n```\nUSAGE\n  $ autify web api delete-access-point --project-id \u003cvalue\u003e --delete-access-point-request \u003cvalue\u003e\n\nFLAGS\n  --delete-access-point-request=\u003cvalue\u003e  (required) A JSON object with the name of the access point to be deleted e.g.\n                                         {\"name\":\"string\"}\n  --project-id=\u003cvalue\u003e                   (required) For example, 1 for the following URL:\n                                         https://app.autify.com/projects/1/scenarios\n\nDESCRIPTION\n  You can delete an access point by passing in its name.\n\nEXAMPLES\n  $ autify web api delete-access-point\n```\n\n_See code: [src/commands/web/api/delete-access-point.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/api/delete-access-point.ts)_\n\n## `autify web api delete-test-plan-variable`\n\nDelete an existing test plan variable for the test plan\n\n```\nUSAGE\n  $ autify web api delete-test-plan-variable --test-plan-id \u003cvalue\u003e --test-plan-variable-id \u003cvalue\u003e\n\nFLAGS\n  --test-plan-id=\u003cvalue\u003e           (required) For example, 15 for the following URL:\n                                   https://app.autify.com/projects/1/test_plans/15/\n  --test-plan-variable-id=\u003cvalue\u003e  (required) test_plan_variable id\n\nDESCRIPTION\n  Delete an existing test plan variable for the test plan\n\nEXAMPLES\n  $ autify web api delete-test-plan-variable\n```\n\n_See code: [src/commands/web/api/delete-test-plan-variable.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/api/delete-test-plan-variable.ts)_\n\n## `autify web api delete-url-replacement`\n\nDelete a url replacement for the test plan\n\n```\nUSAGE\n  $ autify web api delete-url-replacement --test-plan-id \u003cvalue\u003e --url-replacement-id \u003cvalue\u003e\n\nFLAGS\n  --test-plan-id=\u003cvalue\u003e        (required) For example, 15 for the following URL:\n                                https://app.autify.com/projects/1/test_plans/15\n  --url-replacement-id=\u003cvalue\u003e  (required) url_replacement id\n\nDESCRIPTION\n  Delete a url replacement for the test plan\n\nEXAMPLES\n  $ autify web api delete-url-replacement\n```\n\n_See code: [src/commands/web/api/delete-url-replacement.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/api/delete-url-replacement.ts)_\n\n## `autify web api describe-result`\n\nGet a test result.\n\n```\nUSAGE\n  $ autify web api describe-result --project-id \u003cvalue\u003e --result-id \u003cvalue\u003e [--get-details \u003cvalue\u003e]\n\nFLAGS\n  --get-details=\u003cvalue\u003e  The flag to get details of the test case result.\n  --project-id=\u003cvalue\u003e   (required) For example, 1 for the following URL: https://app.autify.com/projects/1/results/4\n  --result-id=\u003cvalue\u003e    (required) For example, 4 for the following URL: https://app.autify.com/projects/1/results/4\n\nDESCRIPTION\n  Get a test result.\n\nEXAMPLES\n  $ autify web api describe-result\n```\n\n_See code: [src/commands/web/api/describe-result.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/api/describe-result.ts)_\n\n## `autify web api describe-scenario`\n\nGet a scenario.\n\n```\nUSAGE\n  $ autify web api describe-scenario --project-id \u003cvalue\u003e --scenario-id \u003cvalue\u003e\n\nFLAGS\n  --project-id=\u003cvalue\u003e   (required) For example, 1 for the following URL: https://app.autify.com/projects/1/scenarios/2\n  --scenario-id=\u003cvalue\u003e  (required) For example, 2 for the following URL: https://app.autify.com/projects/1/scenarios/2\n\nDESCRIPTION\n  Get a scenario.\n\nEXAMPLES\n  $ autify web api describe-scenario\n```\n\n_See code: [src/commands/web/api/describe-scenario.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/api/describe-scenario.ts)_\n\n## `autify web api execute-scenarios`\n\nYou can execute any scenarios in your workspace using any execution environments (which is called \"capabilities\" here).\n\n```\nUSAGE\n  $ autify web api execute-scenarios --project-id \u003cvalue\u003e --execute-scenarios-request \u003cvalue\u003e\n\nFLAGS\n  --execute-scenarios-request=\u003cvalue\u003e\n      (required) A JSON object with the scenarios and settings to execute e.g.\n      {\"name\":\"string\",\"execution_type\":\"parallel\",\"capabilities\":[{\"os\":\"string\",\"os_type\":\"macos\",\"os_version\":\"string\",\n      \"device\":\"string\",\"browser\":\"string\",\"browser_type\":\"chrome\",\"browser_version\":\"string\"}],\"url_replacements\":[{\"patt\n      ern_url\":\"string\",\"replacement_url\":\"string\"}],\"scenarios\":[{\"id\":0}],\"autify_connect\":{\"name\":\"string\"}}\n\n  --project-id=\u003cvalue\u003e\n      (required) For example, 1 for the following URL: https://app.autify.com/projects/1/scenarios\n\nDESCRIPTION\n  You can execute any scenarios in your workspace using any execution environments (which is called \"capabilities\"\n  here).\n\nEXAMPLES\n  $ autify web api execute-scenarios\n```\n\n_See code: [src/commands/web/api/execute-scenarios.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/api/execute-scenarios.ts)_\n\n## `autify web api execute-schedule`\n\n\"Schedule\" is called as \"Test Plan\" now. If you want to run a test plan, use this endpoint.\n\n```\nUSAGE\n  $ autify web api execute-schedule --schedule-id \u003cvalue\u003e [--execute-schedule-request \u003cvalue\u003e]\n\nFLAGS\n  --execute-schedule-request=\u003cvalue\u003e  A JSON object with the options to execute a test plan. e.g.\n                                      {\"autify_connect\":{\"name\":\"string\"}}\n  --schedule-id=\u003cvalue\u003e               (required) For example, 3 for the following URL:\n                                      https://app.autify.com/projects/1/test_plans/3\n\nDESCRIPTION\n  \"Schedule\" is called as \"Test Plan\" now. If you want to run a test plan, use this endpoint.\n\nEXAMPLES\n  $ autify web api execute-schedule\n```\n\n_See code: [src/commands/web/api/execute-schedule.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/api/execute-schedule.ts)_\n\n## `autify web api get-credit-usage`\n\nGet 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.\n\n```\nUSAGE\n  $ autify web api get-credit-usage --project-id \u003cvalue\u003e [--date-from \u003cvalue\u003e] [--date-to \u003cvalue\u003e] [--scenario-id \u003cvalue\u003e]\n    [--test-plan-id \u003cvalue\u003e] [--user-id \u003cvalue\u003e]\n\nFLAGS\n  --date-from=\u003cvalue\u003e     The date to start counting used credits from. If not specified, the date will be set to 1 week\n                          ago. Up to 90 days in advance can be specified. If the specified date is more than 90 days in\n                          the past, the date will be set to 90 days ago. Date must follow the format YYYY-MM-DD\n                          (example: \"2023-09-21\").\n  --date-to=\u003cvalue\u003e       The date to end counting used credits from. If not specified, the date will be set to today.\n                          Date must follow the format YYYY-MM-DD (example: \"2023-09-28\").\n  --project-id=\u003cvalue\u003e    (required) For example, 1 for the following URL: https://app.autify.com/projects/1/credits\n  --scenario-id=\u003cvalue\u003e   The scenario ID to filter used credits by.\n  --test-plan-id=\u003cvalue\u003e  The test plan ID to filter used credits by.\n  --user-id=\u003cvalue\u003e       The user ID that executed tests to filter used credits by.\n\nDESCRIPTION\n  Get the number of credits used in the project  Notes: This endpoint works only for organizations on credit-based\n  plans. It always returns 0 for `credits_consumed` and `credit_consumption_event_count` if your organization is on a\n  run-based plan.\n\nEXAMPLES\n  $ autify web api get-credit-usage\n```\n\n_See code: [src/commands/web/api/get-credit-usage.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/api/get-credit-usage.ts)_\n\n## `autify web api get-project-info`\n\nGet project information.\n\n```\nUSAGE\n  $ autify web api get-project-info --project-id \u003cvalue\u003e\n\nFLAGS\n  --project-id=\u003cvalue\u003e  (required) For example, 1 for the following URL: https://app.autify.com/projects/1/project_info\n\nDESCRIPTION\n  Get project information.\n\nEXAMPLES\n  $ autify web api get-project-info\n```\n\n_See code: [src/commands/web/api/get-project-info.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/api/get-project-info.ts)_\n\n## `autify web api list-access-points`\n\nList access points for the project.\n\n```\nUSAGE\n  $ autify web api list-access-points --project-id \u003cvalue\u003e [--page \u003cvalue\u003e]\n\nFLAGS\n  --page=\u003cvalue\u003e        The number of page returns.\n  --project-id=\u003cvalue\u003e  (required) For example, 1 for the following URL: https://app.autify.com/projects/1/scenarios\n\nDESCRIPTION\n  List access points for the project.\n\nEXAMPLES\n  $ autify web api list-access-points\n```\n\n_See code: [src/commands/web/api/list-access-points.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/api/list-access-points.ts)_\n\n## `autify web api list-capabilities`\n\nList available Capabilities.\n\n```\nUSAGE\n  $ autify web api list-capabilities --project-id \u003cvalue\u003e [--os \u003cvalue\u003e] [--os-type \u003cvalue\u003e] [--browser \u003cvalue\u003e]\n    [--browser-type \u003cvalue\u003e] [--device-type \u003cvalue\u003e]\n\nFLAGS\n  --browser=\u003cvalue\u003e       browser name to filter (deprecated)\n  --browser-type=\u003cvalue\u003e  Type of the browser to filter\n  --device-type=\u003cvalue\u003e   device_type name to filter (mobile is deprecated)\n  --os=\u003cvalue\u003e            os name to filter (deprecated)\n  --os-type=\u003cvalue\u003e       Type of the os to filter\n  --project-id=\u003cvalue\u003e    (required) For example, 1 for the following URL:\n                          https://app.autify.com/projects/1/capabilities\n\nDESCRIPTION\n  List available Capabilities.\n\nEXAMPLES\n  $ autify web api list-capabilities\n```\n\n_See code: [src/commands/web/api/list-capabilities.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/api/list-capabilities.ts)_\n\n## `autify web api list-results`\n\nList test results.\n\n```\nUSAGE\n  $ autify web api list-results --project-id \u003cvalue\u003e [--page \u003cvalue\u003e] [--per-page \u003cvalue\u003e] [--test-plan-id \u003cvalue\u003e]\n\nFLAGS\n  --page=\u003cvalue\u003e          The number of page returns.\n  --per-page=\u003cvalue\u003e      The number of items returns. Default number is 30 and up to a maximum of 100\n  --project-id=\u003cvalue\u003e    (required) For example, 1 for the following URL: https://app.autify.com/projects/1/results\n  --test-plan-id=\u003cvalue\u003e  Test plan ID used to filter results.\n\nDESCRIPTION\n  List test results.\n\nEXAMPLES\n  $ autify web api list-results\n```\n\n_See code: [src/commands/web/api/list-results.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/api/list-results.ts)_\n\n## `autify web api list-scenarios`\n\nList scenarios.\n\n```\nUSAGE\n  $ autify web api list-scenarios --project-id \u003cvalue\u003e [--page \u003cvalue\u003e]\n\nFLAGS\n  --page=\u003cvalue\u003e        The number of page returns.\n  --project-id=\u003cvalue\u003e  (required) For example, 1 for the following URL: https://app.autify.com/projects/1/scenarios\n\nDESCRIPTION\n  List scenarios.\n\nEXAMPLES\n  $ autify web api list-scenarios\n```\n\n_See code: [src/commands/web/api/list-scenarios.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/api/list-scenarios.ts)_\n\n## `autify web api list-test-plan-variable`\n\nList the test plan's variables\n\n```\nUSAGE\n  $ autify web api list-test-plan-variable --test-plan-id \u003cvalue\u003e\n\nFLAGS\n  --test-plan-id=\u003cvalue\u003e  (required) For example, 15 for the following URL:\n                          https://app.autify.com/projects/1/test_plans/15\n\nDESCRIPTION\n  List the test plan's variables\n\nEXAMPLES\n  $ autify web api list-test-plan-variable\n```\n\n_See code: [src/commands/web/api/list-test-plan-variable.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/api/list-test-plan-variable.ts)_\n\n## `autify web api list-url-replacements`\n\nList url replacements for the test plan\n\n```\nUSAGE\n  $ autify web api list-url-replacements --test-plan-id \u003cvalue\u003e\n\nFLAGS\n  --test-plan-id=\u003cvalue\u003e  (required) For example, 15 for the following URL:\n                          https://app.autify.com/projects/1/test_plans/15\n\nDESCRIPTION\n  List url replacements for the test plan\n\nEXAMPLES\n  $ autify web api list-url-replacements\n```\n\n_See code: [src/commands/web/api/list-url-replacements.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/api/list-url-replacements.ts)_\n\n## `autify web api update-test-plan-variable`\n\nUpdate a url replacement for the test plan\n\n```\nUSAGE\n  $ autify web api update-test-plan-variable --test-plan-id \u003cvalue\u003e --test-plan-variable-id \u003cvalue\u003e --update-test-plan-variable-request\n    \u003cvalue\u003e\n\nFLAGS\n  --test-plan-id=\u003cvalue\u003e                       (required) For example, 15 for the following URL:\n                                               https://app.autify.com/projects/1/test_plans/15\n  --test-plan-variable-id=\u003cvalue\u003e              (required) test_plan_variable id\n  --update-test-plan-variable-request=\u003cvalue\u003e  (required) A JSON object with the variable's new key and/or\n                                               default_value's value to register e.g.\n                                               {\"key\":\"string\",\"default_value\":\"string\"}\n\nDESCRIPTION\n  Update a url replacement for the test plan\n\nEXAMPLES\n  $ autify web api update-test-plan-variable\n```\n\n_See code: [src/commands/web/api/update-test-plan-variable.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/api/update-test-plan-variable.ts)_\n\n## `autify web api update-url-replacement`\n\nUpdate a url replacement for the test plan\n\n```\nUSAGE\n  $ autify web api update-url-replacement --test-plan-id \u003cvalue\u003e --url-replacement-id \u003cvalue\u003e --update-url-replacement-request\n    \u003cvalue\u003e\n\nFLAGS\n  --test-plan-id=\u003cvalue\u003e                    (required) For example, 15 for the following URL:\n                                            https://app.autify.com/projects/1/test_plans/15\n  --update-url-replacement-request=\u003cvalue\u003e  (required) A JSON object with the url to replace. Either pattern_url or\n                                            replacement_url is required. e.g.\n                                            {\"pattern_url\":\"string\",\"replacement_url\":\"string\"}\n  --url-replacement-id=\u003cvalue\u003e              (required) url_replacement id\n\nDESCRIPTION\n  Update a url replacement for the test plan\n\nEXAMPLES\n  $ autify web api update-url-replacement\n```\n\n_See code: [src/commands/web/api/update-url-replacement.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/api/update-url-replacement.ts)_\n\n## `autify web auth login`\n\nLogin to Autify for Web\n\n```\nUSAGE\n  $ autify web auth login\n\nDESCRIPTION\n  Login to Autify for Web\n\nEXAMPLES\n  Start interactive setup:\n\n    $ autify web auth login\n\n  Reading the token from file:\n\n    $ autify web auth login \u003c token.txt\n```\n\n_See code: [src/commands/web/auth/login.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/auth/login.ts)_\n\n## `autify web test run SCENARIO-OR-TEST-PLAN-URL`\n\nRun a scenario or test plan.\n\n```\nUSAGE\n  $ autify web test run SCENARIO-OR-TEST-PLAN-URL [-n \u003cvalue\u003e] [-r \u003cvalue\u003e...] [--autify-connect \u003cvalue\u003e |\n    --autify-connect-client] [--autify-connect-client-verbose ] [--autify-connect-client-file-logging ]\n    [--autify-connect-client-debug-server-port \u003cvalue\u003e ] [--autify-connect-client-extra-arguments \u003cvalue\u003e ] [--os\n    \u003cvalue\u003e] [--os-version \u003cvalue\u003e] [--browser \u003cvalue\u003e] [--device \u003cvalue\u003e] [--device-type \u003cvalue\u003e] [-w] [-t \u003cvalue\u003e]\n    [-v] [--max-retry-count \u003cvalue\u003e]\n\nARGUMENTS\n  SCENARIO-OR-TEST-PLAN-URL  Scenario URL or Test plan URL e.g.\n                             https://app.autify.com/projects/\u003cID\u003e/(scenarios|test_plans)/\u003cID\u003e\n\nFLAGS\n  -n, --name=\u003cvalue\u003e                                     [Only for test scenario] Name of the test execution.\n  -r, --url-replacements=\u003cvalue\u003e...                      URL replacements. Example: \"http://example.com\n                                                         http://example.net\"\n  -t, --timeout=\u003cvalue\u003e                                  [default: 300] Timeout seconds when waiting for the finish of\n                                                         the test execution.\n  -v, --verbose                                          Verbose output\n  -w, --wait                                             Wait until the test finishes.\n      --autify-connect=\u003cvalue\u003e                           Name of the Autify Connect Access Point.\n      --autify-connect-client                            Start Autify Connect Client\n      --autify-connect-client-debug-server-port=\u003cvalue\u003e  Port for Autify Connect Client debug server. A random port will\n                                                         be used if not specified.\n      --autify-connect-client-extra-arguments=\u003cvalue\u003e    Extra command line arguments you want to pass to Autify Connect\n                                                         Client e.g. \"--tunnel-proxy http://proxy\".\n      --autify-connect-client-file-logging               Logging Autify Connect Client log to a file instead of console.\n      --autify-connect-client-verbose                    Verbose output for Autify Connect Client.\n      --browser=\u003cvalue\u003e                                  [Only for test scenario] Browser to run the test\n      --device=\u003cvalue\u003e                                   [Only for test scenario] Device to run the test\n      --device-type=\u003cvalue\u003e                              [Only for test scenario] Device type to run the test\n      --max-retry-count=\u003cvalue\u003e                          Maximum retry count while waiting. The command can take up to\n                                                         `timeout * (max-retry-count + 1)`. Only effective with\n                                                         `--wait`.\n      --os=\u003cvalue\u003e                                       [Only for test scenario] OS to run the test\n      --os-version=\u003cvalue\u003e                               [Only for test scenario] OS version to run the test\n\nDESCRIPTION\n  Run a scenario or test plan.\n\nEXAMPLES\n  Run a test scenario (Default capability):\n\n    $ autify web test run https://app.autify.com/projects/0000/scenarios/0000\n\n  Run a test plan:\n\n    $ autify web test run https://app.autify.com/projects/0000/test_plans/0000\n\n  Run and wait a test scenario:\n\n    $ autify web test run https://app.autify.com/projects/0000/scenarios/0000 --wait --timeout 600\n\n  Run a test scenario with a specific capability:\n\n    $ autify web test run https://app.autify.com/projects/0000/scenarios/0000 --os \"Windows Server\" --browser Edge\n\n  With URL replacements:\n\n    $ autify web test run https://app.autify.com/projects/0000/scenarios/0000 -r \"http://example.com \\\n      http://example.net\" -r \"http://example.org http://example.net\"\n\n  Run a test with specifying the execution name:\n\n    $ autify web test run https://app.autify.com/projects/0000/scenarios/0000 --name \"Sample execution\"\n\n  Run a test scenario with Autify Connect:\n\n    $ autify web test run https://app.autify.com/projects/0000/scenarios/0000 --autify-connect NAME\n\n  Run a test scenario with Autify Connect Client:\n\n    $ autify web test run https://app.autify.com/projects/0000/scenarios/0000 --wait --autify-connect-client\n```\n\n_See code: [src/commands/web/test/run.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/test/run.ts)_\n\n## `autify web test wait TEST-RESULT-URL`\n\nWait a test result until it finishes.\n\n```\nUSAGE\n  $ autify web test wait TEST-RESULT-URL [-t \u003cvalue\u003e] [-v]\n\nARGUMENTS\n  TEST-RESULT-URL  Test result URL e.g. https://app.autify.com/projects/\u003cID\u003e/results/\u003cID\u003e\n\nFLAGS\n  -t, --timeout=\u003cvalue\u003e  [default: 300] Timeout seconds when waiting for the finish of the test execution.\n  -v, --verbose          Verbose output\n\nDESCRIPTION\n  Wait a test result until it finishes.\n\nEXAMPLES\n  $ autify web test wait https://app.autify.com/projects/0000/results/0000\n```\n\n_See code: [src/commands/web/test/wait.ts](https://github.com/autifyhq/autify-cli/blob/v0.68.0-beta.0/src/commands/web/test/wait.ts)_\n\n\u003c!-- commandsstop --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautifyhq%2Fautify-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fautifyhq%2Fautify-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautifyhq%2Fautify-cli/lists"}