mabl CLI command reference

Get a forensic artifact (console, dom, network, screenshot) for a test run step

mabl agent debug artifact {type} {id}

Positionals:
  type  Artifact type to fetch  [required] [choices: "console", "dom", "network", "screenshot"]
  id    Test run ID, e.g. abc123-jr  [string] [required]

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]
  --step-run-id  Step run ID  [string] [required]
  --before       Screenshot only — fetch the before-action snapshot rather than the post-action one  [boolean] [default: false]
  --print        Stream the cached artifact contents to stdout (text artifacts only)  [boolean] [default: false]
  --head         Stream the first N lines of the cached artifact to stdout. Mutually exclusive with --tail/--bytes/--print/--query/--text-only  [number]
  --tail         Stream the last N lines of the cached artifact to stdout. Mutually exclusive with --head/--bytes/--print/--query/--text-only  [number]
  --bytes        Stream the first N bytes of the cached artifact to stdout. Mutually exclusive with --head/--tail/--print/--query/--text-only  [number]
  --query        Run a jq expression against the JSON artifact and stream the result to stdout. Only valid for console and network. Requires `jq` on PATH.  [string]
  --text-only    DOM only — emit a one-line-per-element listing (role, name, id, data-testid) instead of the raw HTML  [boolean] [default: false]

Get the failed and recovered (by Runtime recovery) steps from a test run. Pass --all for the full trace.

mabl agent debug steps {id}

Positionals:
  id  Test run ID, e.g. abc123-jr  [string] [required]

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]
  --all          Emit every executed step instead of the failed/recovered subset. The summary block is unchanged.  [boolean] [default: false]

Install the mabl-debug skill (plus chrome-for-mabl and mabl MCP entries on supported targets) into an AI tool

mabl agent install {target}

Positionals:
  target  AI tool to install into (supported: claude, vscode, cursor, copilot, agents-md)  [string] [required]

Options:
  --version, -v     Show version number  [boolean]
  --help, -h        Show help  [boolean]
  --scope           Install scope: 'user' (in your home directory) or 'project' (in the current directory). 'agents-md' is project-only.  [string] [choices: "user", "project"] [default: "user"]
  --force           Overwrite an existing skill file and replace any existing chrome-for-mabl / mabl MCP entries  [boolean] [default: false]
  --skip-mcp        Install the skill only; do not touch the target MCP configuration  [boolean] [default: false]
  --append-snippet  Also append the mabl agent debug snippet to the agent instruction file (CLAUDE.md, .cursorrules, AGENTS.md, …)  [boolean] [default: false]

Describe a specific application

mabl applications describe {id}

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]
  --output, -o   Specify output format  [choices: "json", "yaml"]

List your applications

mabl applications list

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --workspace-id, -w  Workspace to list applications for  [string]
  --limit, -l         The number of applications to return'  [string] [default: 10]
  --output, -o        Specify result output format  [choices: "json", "yaml"]

Activate auth by api key

mabl auth activate-key {api-key}

Positionals:
  api-key  API key (escape leading dashes with "\" (e.g. "\-yourKey")  [string] [required]

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]

Clear logged in user

mabl auth clear

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]

Display logged in user

mabl auth info

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]

Authenticate the mabl CLI

mabl auth login

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]

Create a new mabl branch

mabl branches create {name}

Positionals:
  name  Name of the mabl branch to create  [string] [required]

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --output, -o        Specify an output type for the branch data  [choices: "json", "yaml"]
  --workspace-id, -w  The workspace ID to create a new branch  [string]

Delete a mabl branch by id or name

mabl branches delete {identifier}

Positionals:
  identifier  The branch ID or NAME to delete  [string] [required]

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --name, -n          Use identifier as branch name  [boolean] [default: false]
  --workspace-id, -w  The workspace ID to delete a branch by name  [string]

Describe a specific mabl branch by id or name

mabl branches describe {identifier}

Positionals:
  identifier  The branch ID or NAME to describe  [string] [required]

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --name, -n          Use identifier as Get branch based on name  [boolean] [default: false]
  --output, -o        Specify an output type for the branch data  [choices: "json", "yaml"]
  --workspace-id, -w  The workspace ID to create a new branch  [string]

List mabl branches

mabl branches list

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --limit, -l         Item return limit  [default: 10]
  --output, -o        Specify result output format  [choices: "json", "yaml"]
  --status, -s        filter results by status  [choices: "open", "merged"]
  --workspace-id, -w  The workspace ID to list branches for

Merge mabl branches

mabl branches merge

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --from, -f          Name of the mabl branch to merge from  [string] [required]
  --to, -t            Name of the mabl branch to merge to  [string] [default: "master"]
  --output, -o        Specify an output type for the branch data  [choices: "json", "yaml"]
  --workspace-id, -w  The workspace ID to create a new branch  [string]

Delete a config value

mabl config delete {config-key}

Positionals:
  config-key  configuration key to delete  [string] [required] [choices: "browser.path", "alpha.scm_metadata.enable", "workspace", "http.proxy", "http.sslVerify", "http.proxyMode", "http.proxyType"]

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]

Get a config value

mabl config get {config-key}

Positionals:
  config-key  desired configuration key  [string] [required]

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]

Install add-on tools like mobile testing drivers

mabl config install {add-on}

Positionals:
  add-on  add-on to install  [string] [required] [choices: "mobile-tools", "browser"]

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]
  --android      [mobile-tools] The android driver version to use  [string]
  --ios          [mobile-tools] The ios driver version to use  [string]
  --chrome       [browser] The chrome browser version to use  [boolean]

List all user config values

mabl config list

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]

Set a default configuration key

mabl config set {config-key} {config-value}

Positionals:
  config-key    The configuration key to set  [string] [required] [choices: "browser.path", "alpha.scm_metadata.enable", "workspace", "http.proxy", "http.sslVerify", "http.proxyMode", "http.proxyType"]
  config-value  The value to configure for the config  [string] [required]

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]

List your credentials

mabl credentials list

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --workspace-id, -w  Workspace to list credentials for  [string]
  --limit, -l         The number of credentials to return'  [string] [default: 10]
  --output, -o        Specify result output format  [choices: "json", "yaml"]

List your databases

mabl databases list

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --workspace-id, -w  Workspace to list databases for  [string]
  --limit, -l         The number of databases to return'  [string] [default: 10]
  --output, -o        Specify result output format  [choices: "json", "yaml"]

Create a new mabl DataTable

mabl datatables create {input}

Positionals:
  input, file  Relative path file to create DataTable from  [required]

Options:
  --version, -v         Show version number  [boolean]
  --help, -h            Show help  [boolean]
  --workspace-id, -w    Workspace to create DataTable in  [string]
  --name, --table-name  The name for your new DataTable  [string]
  --format, --fmt       Specify the format of your input file (checks file extension type by default)  [choices: "json", "csv"]

Describe a specific DataTable

mabl datatables describe {id}

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]
  --output, -o   Specify output format  [choices: "json", "yaml"]

Export a DataTable in a specified file format

mabl datatables export {id}

Positionals:
  id  DataTable id to export  [string] [required]

Options:
  --version, -v    Show version number  [boolean]
  --help, -h       Show help  [boolean]
  --format, --fmt  Specify a format for the DataTable export  [choices: "json", "yaml", "csv"] [default: "json"]

List your DataTables

mabl datatables list

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --workspace-id, -w  Workspace to list datatables for  [string]
  --limit, -l         The number of datatables to return'  [string] [default: 10]
  --output, -o        Specify result output format  [choices: "json", "yaml"]

List the scenarios of a datatable

mabl datatables scenarios {id}

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]
  --limit, -l    The number of scenarios to return'  [string] [default: 10]
  --output, -o   Specify result output format  [choices: "json", "yaml"]

Update a mabl DataTable

mabl datatables update {id} {input}

Positionals:
  id           ID of DataTable to update  [string] [required]
  input, file  Relative path file to create DataTable from  [required]

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --workspace-id, -w  Workspace your DataTable is exists in  [string]
  --format, --fmt     Specify the format of your input file (checks file extension type by default)  [choices: "json", "csv"]

Trigger a deployment event via the mabl API

mabl deployments create

Options:
  --version, -v                  Show version number  [boolean]
  --help, -h                     Show help  [boolean]
  --application-id, -a           Application to run the mabl tests for. If provided, mabl will only trigger plans that contain this application  [string]
  --environment-id, -e           Environment to run the mabl tests for. If provided, mabl will only trigger plans that contain this environment  [string]
  --override-environment-id      Override environment to run the tests against. Not used to select plans to run. Requires `--application-id`.  [string]
  --await-completion             Block until mabl tests complete.  [boolean] [default: false]
  --fast-failure                 If using '--await-completion', exit on first failed test  [boolean] [default: false]
  --silent                       Don't output runtime status  [boolean] [default: false]
  --output, -o                   Specify final result output format. Implies: --silent  [choices: "json", "yaml"]
  --workspace-id, -w             Workspace containing target environment and/or application  [string]
  --browsers, -b                 Space delimited browsers to test against (e.g. "chrome firefox")  [array] [choices: "chrome", "edge", "firefox", "webkit"] [default: []]
  --labels, -l                   Space delimited plan labels. Run plans that match any label.  [array] [default: []]
  --http-headers                 Space delimited HTTP headers added to browser requests (e.g. "x-header:foo")  [array] [default: []]
  --url, -u                      URL to use for deployment  [string]
  --app-url                      Application/web URL to use for deployment  [string]
  --api-url                      API URL to to use for deployment  [string]
  --android-app-file-id          Android mobile app file to use for deployment  [string]
  --ios-app-file-id              iOS mobile app file to use for deployment  [string]
  --api-key, -k                  API key (found in the mabl web app)  [string]
  --rebaseline-images, --rbi     Rebaseline visual change models  [boolean] [default: false]
  --set-static-baseline, --ssbi  Set run as fixed baseline for visual change models  [boolean] [default: false]
  --revision, --rev              Code revision hash (application under test)  [string]
  --repository-url               Code repository URL (e.g. git@github.com:foo/bar.git)  [string]
  --mabl-branch                  mabl branch to run tests against  [string]
  --auto-branch                  Create a mabl branch when a mabl-branch target is specified that does not exist  [boolean] [default: false]
  --snapshot-from                Snapshot the current state of the tests from a mabl branch onto the environment. Use "master" for the mainline branch.  Requires setting environment-id.  [string]

Describe a specific mabl deployment event

mabl deployments describe {id}

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]
  --output, -o   Specify and alternate output for the deployment data  [choices: "json", "yaml", "markdown"]

List recent mabl deployment events

mabl deployments list

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --workspace-id, -w  Workspace to list deployments for  [string]
  --limit, -l         The number of deployments to return'  [string] [default: 10]
  --output, -o        Specify result output format  [choices: "json", "yaml"]

Watch a mabl deployment event until completion, with results

mabl deployments watch {id}

Options:
  --version, -v   Show version number  [boolean]
  --help, -h      Show help  [boolean]
  --fast-failure  Exit on first failed test  [boolean] [default: false]
  --silent        Don't output runtime status  [boolean] [default: false]
  --output, -o    Specify final result output format. Implies: --silent  [choices: "json", "yaml"]

Associate mobile build file with an environment

mabl environments build-files add {id}

Positionals:
  id  ID of environment to add mobile build file associations to  [string] [required]

Options:
  --version, -v     Show version number  [boolean]
  --help, -h        Show help  [boolean]
  --application-id  ID of application to associate with this environment  [string] [required]
  --build-file-id   mobile build file ID to associate with the application-environment pair  [string] [required]

Show build files associated with an environment

mabl environments build-files list {id}

Positionals:
  id  Environment ID to list build file associations for  [string] [required]

Options:
  --version, -v         Show version number  [boolean]
  --help, -h            Show help  [boolean]
  --application-id, -a  Application ID to filter build files by  [string]
  --limit, -l           The number of build files to return'  [string] [default: 10]
  --output, -o          Specify result output format  [choices: "json", "yaml"]

Update mobile build file associated with an environment or add new association

mabl environments build-files update {id}

Positionals:
  id  ID of environment to update mobile build file association  [string] [required]

Options:
  --version, -v     Show version number  [boolean]
  --help, -h        Show help  [boolean]
  --application-id  ID of application to associate with this environment  [string] [required]
  --build-file-id   mobile build file ID to associate with the application-environment pair  [string] [required]

Create a new mabl environment

mabl environments create

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --application-id    Id of application to associate with this environment  [string]
  --app-url           Web application URLs to associate with the application-environment pair  [array]
  --api-url           API URLs to associate with the application-environment pair  [array]
  --name, -n          Name of the environment  [string] [required]
  --description       Description of the environment  [string]
  --variables         Key-value environment variable pairs of the form var1:value1  [array] [default: []]
  --link              Name of link agent to use for this environment  [string]
  --mabl-branch       Name of mabl branch to associated with this environment.  Tests run against this environment will use the version on this branch.  [string]
  --preview           Set to true to mark this as an preview environment  [boolean] [default: false]
  --workspace-id, -w  Workspace containing to create environment in  [string]

Delete a mabl environment

mabl environments delete {id}

Positionals:
  id  Environment id to delete  [string] [required]

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]

Describe a specific environment

mabl environments describe {id}

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]
  --decrypt      Set to decrypt and return environment variables as part of the payload  [boolean]
  --output, -o   Specify output format  [choices: "json", "yaml"]

List your environments

mabl environments list

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --workspace-id, -w  Workspace to list environments for  [string]
  --limit, -l         The number of environments to return'  [string] [default: 10]
  --output, -o        Specify result output format  [choices: "json", "yaml"]

Update a mabl environment. Note: This overwrites all existing environment variables set for the environment.

mabl environments update {id}

Positionals:
  id  ID of environment to update  [string] [required]

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]
  --name, -n     Name of the environment  [string]
  --description  Description of the environment  [string]
  --variables    Key-value environment variable pairs of the form var1:value1  [array] [default: []]
  --link         Name of link agent to use for this environment  [string]
  --mabl-branch  Name of mabl branch to associated with this environment.  Tests run against this environment will use the version on this branch.  [string]
  --preview      Set to true to mark this as an preview environment  [boolean] [default: false]

Associate URLs with an environment

mabl environments urls add {id}

Positionals:
  id  Id of environment to add URL associations to  [string] [required]

Options:
  --version, -v     Show version number  [boolean]
  --help, -h        Show help  [boolean]
  --application-id  id of application to associate with this environment  [string] [required]
  --app-url         web application URLs to associate with the application-environment pair  [array]
  --api-url         API URLs to associate with the application-environment pair  [array]

Show URLs associated with an environment

mabl environments urls list {id}

Positionals:
  id  Environment id to list URL associations for  [string] [required]

Options:
  --version, -v         Show version number  [boolean]
  --help, -h            Show help  [boolean]
  --application-id, -a  Application id to filter URLs by  [string]
  --limit, -l           The number of URLs to return'  [string] [default: 10]
  --output, -o          Specify result output format  [choices: "json", "yaml"]

Export a mabl flow in a specified file format

mabl flows export {id}

Positionals:
  id  flow id to export  [string] [required]

Options:
  --version, -v    Show version number  [boolean]
  --help, -h       Show help  [boolean]
  --format, --fmt  Specify a format for the flow export  [choices: "json", "yaml", "csv", "postman"] [default: "yaml"]
  --mabl-branch    Which branch of the flow to export  [string]

List flows

mabl flows list

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --workspace-id, -w  Workspace to list flows for  [string]
  --limit, -l         The number of flows to return  [string] [default: 10]

Launch an interactive CLI training session to record browser tests

mabl internal cli-trainer {url} {test-name}

Positionals:
  url        The URL to start training at  [string] [required]
  test-name  The name of the test to create  [string] [required]

Options:
  --version, -v               Show version number  [boolean]
  --help, -h                  Show help  [boolean]
  --workspace-id, -w          Workspace to create test in  [string] [default: false]
  --application-id, -a        Mabl application to create test under  [string]
  --test-description, --desc  Description for the test  [string]
  --labels                    Space delimited labels to save test with  [array]
  --headless                  Run browser in headless mode (not recommended for training)  [boolean] [default: false]
  --auto-save, --save         Automatically save test when training ends  [boolean] [default: false]
  --width                     Set the browser width in pixels  [number] [default: 1080]
  --height                    Set the browser height in pixels  [number] [default: 1440]
  --log-file                  Write verbose logs to this file (terminal shows only steps)  [string]
  --watch, -w                 Watch contentJs source files and hot-reload on changes  [string] [default: false]

Run a A/B testing comparing two mablscript-versions

mabl internal find-ab-test

Options:
  --version, -v              Show version number  [boolean]
  --help, -h                 Show help  [boolean]
  --id                       The id of the test to run  [string]
  --from-plan-id             The plan id to get a list of tests from. The environment id and the credentials id will be used as well unless supplied  [string]
  --credentials-id, --creds  Credentials ID to run the test with  [string]
  --labels                   Space delimited test labels. Run tests that match any label.  [array]
  --exclude-labels           Space delimited test labels. Exclude tests that match any label.  [array]
  --workspace-id, -w         Workspace to run against  [string]
  --environment-id, -e       Mabl environment to run under. Specify to ensure the test runs with environment variables and the latest find information.  [string]
  --url, -u                  URL to run the mabl test against  [string]
  --headless                 Should the test run headless or not  [boolean] [default: false]
  --keep-browser-open        Prevent the browser from closing at the end of a test.  [boolean] [default: false]
  --ab-config-file           Config file with the battery of tests to run  [string]
  --find-path                Path of the mablscript-find version to test (B side)  [string] [required]
  --output                   Output file  [string]
  --existing-report          If set, only the "B" side tests will be executed, and the new generated report will include data from the existing one  [string]
Examples:
  mabl internal find-ab-test --findPath ../mablscript-find/esbuild/mablFind.js --abConfigFile ../mablscript-find/ab-test-config.json  runs all the tests configured in the --abConfigFile file using the packaged version and the version in --findPath

Launch a find laboratory instance

mabl internal find-lab

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]
  --url, -u      URL to launch the find lab against  [string]

Start the Test Execution Proxy server

mabl internal proxy start

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]
  --port         The port to listen on  [number] [default: 8080]

Delete link agents and infrastructure associate with the link agent label and block new agents with the given label for 15 minutes. Customers dynamically creating link agents must call this when the agent is no longer needed.

mabl link-agents delete {link}

Positionals:
  link  label of the link agent  [string] [required]

Options:
  --version, -v   Show version number  [boolean]
  --help, -h      Show help  [boolean]
  --workspace-id  workspace id of the link agent  [string]

List link agents

mabl link-agents list

Options:
  --version, -v        Show version number  [boolean]
  --help, -h           Show help  [boolean]
  --workspace-id, -w   Workspace for which to list link agents  [string]
  --output, -o         Specify result output format  [choices: "json", "yaml", "table"] [default: "table"]
  --limit, -l          The number of link agents to return  [number] [default: 10]
  --max-heartbeat-age  Only returns link agents that have sent a heartbeat within this number of seconds  [number] [default: 300]

Sends a shutdown signal to a specific Link Agent.

mabl link-agents terminate {id}

Positionals:
  id  id of the link agent to terminate  [string] [required]

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]

Delete a mobile build file.

mabl mobile-build-files delete {id}

Positionals:
  id  ID of the mobile build file  [string] [required]

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]

Download a mobile build file.

mabl mobile-build-files download {id} {destination}

Positionals:
  id           ID of the mobile build file  [string] [required]
  destination  Relative path to destination directory or file  [string] [required]

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]

List your mobile build files

mabl mobile-build-files list

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --workspace-id, -w  Workspace to list mobile build files for  [string]
  --limit, -l         The number of mobile build files to return'  [string] [default: 10]
  --output, -o        Specify result output format  [choices: "json", "yaml"]

Upload a new mobile build file

mabl mobile-build-files upload {build-file-path}

Positionals:
  build-file-path  Relative path to mobile build file file  [required]

Options:
  --help, -h          Show help  [boolean]
  --branch            Branch from which this mobile build file was built  [string]
  --labels            Space delimited labels to save the file with  [array]
  --platform          The mobile platform  [string] [choices: "android", "ios"] [default: inferred from app binary extension]
  --version           Version of this mobile build file  [string]
  --workspace-id, -w  Workspace to create mobile build file in  [string]

Describe a specific plan

mabl plans describe {id}

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]
  --output, -o   Specify output format  [choices: "json", "yaml"]

List plans

mabl plans list

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --workspace-id, -w  Workspace to list plans for  [string]
  --output, -o        Specify result output format  [choices: "json", "yaml", "table"] [default: "table"]
  --limit, -l         The number of plans to return  [string] [default: 10]

Export browser test run artifacts. Defaults to screenshots only.

mabl test-runs export {id} [options]

Positionals:
  id  test run id  [string] [required]

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]
  --file         export to specific file, default: local path/export name  [string]
  --types        types to export, defaults to screenshots only  [array] [choices: "all", "screenshots", "console_logs", "doms", "hars", "traces", "xray_json", "variables"] [default: ["screenshots"]]
Examples:
  mabl test-runs export {id}                           export test run screenshots to file
  mabl test-runs export {id} --types screenshots doms  export test run screenshots and doms to file
  mabl test-runs export {id} --types all               export test run all types to file

Check the status of a cloud test generation initiated by create --mode cloud

mabl tests cloud-status

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]
  --session-id   The agent session ID from create --mode cloud  [string] [required]
  --instance-id  The cloud instance ID from create --mode cloud  [string]
  --output       Output format: "json" for machine-readable output  [string]

Create a browser test using the mabl Trainer

mabl tests create {url} {test-name}

Positionals:
  url        The url to test  [string] [required]
  test-name  The name of the test  [string] [required]

Options:
  --version, -v               Show version number  [boolean]
  --help, -h                  Show help  [boolean]
  --desc, --test-description  Description for the test  [string] [default: ""]
  --width                     Set the browser width in pixels  [number] [default: 1080]
  --height                    Set the browser height in pixels  [number] [default: 1440]
  --mabl-branch               Branch to run the mabl test against  [string]
  --environment-id, -e        Mabl environment to create test under  [string]
  --application-id, -a        Mabl application to create test under  [string]
  --plan-id                   Mabl plan to use the config from and add the test to upon completion  [string]
  --auto-branch               Create a mabl branch when a mabl-branch target is specified that does not exist  [boolean] [default: false]
  --auto-login                Insert an auto login flow at the beginning of the created test  [boolean] [default: false]
  --labels                    Space delimited labels to save test with  [array]
  --data-tables               Space delimited data table IDs to use with test  [array]
  --workspace-id, -w          Workspace to create test in  [string]
  --credentials-id, --creds   Credentials ID to run the test with  [string]
  --intent                    Intent for the test, e.g. "smoke", "regression"  [string]
  --disabled                  Create the test in a disabled state  [boolean] [default: false]
  --empty                     Create a minimal test with only viewport and visit-URL steps  [boolean] [default: false]
  --mode                      Test generation mode: "local" runs locally (default), "cloud" runs in the mabl cloud and returns session/instance IDs for polling status.  [string] [choices: "local", "cloud"] [default: "local"]

Edit a browser test in the Trainer

mabl tests edit

Options:
  --version, -v              Show version number  [boolean]
  --help, -h                 Show help  [boolean]
  --id                       the id of the test to edit  [string]
  --run-id                   The id of the test run to pull config from  [string]
  --mabl-branch              Branch to edit the mabl test against  [string]
  --auto-branch              Create a mabl branch when a mabl-branch target is specified that does not exist  [boolean] [default: false]
  --environment-id, -e       Mabl environment to edit the test under. Specify to edit the test with environment variables and the latest find information.  [string]
  --application-id, -a       Mabl application to edit the test under  [string]
  --width                    Set the browser width in pixels  [number] [default: 1080]
  --height                   Set the browser height in pixels  [number] [default: 1440]
  --url, -u                  URL to edit the mabl test against  [string]
  --credentials-id, --creds  Credentials ID to edit the test with  [string]
Examples:
  mabl tests edit --id {id}               edit test in the Trainer by id
  mabl tests edit --run-id {test-run-id}  edit a browser test in the Trainer in the context of a test configuration from a cloud run

Export a mabl browser test in a specified file format

mabl tests export {id}

Positionals:
  id  test id to export  [string] [required]

Options:
  --version, -v         Show version number  [boolean]
  --help, -h            Show help  [boolean]
  --format, --fmt       Specify a format for the test export  [choices: "json", "yaml", "csv", "playwright", "postman", "side"] [default: "yaml"]
  --mabl-branch         Which branch of the test to export  [string]
  --environment-id, -e  Generate selectors based on the find information learned in this environment (Playwright only)  [string]
  --file                Export to specific file, default: local path/export name  [string]

List tests

mabl tests list

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --workspace-id, -w  Workspace to list tests for  [string]
  --labels            Space delimited test labels to list tests for  [array]
  --output, -o        Specify result output format  [choices: "json", "yaml", "table"] [default: "table"]
  --limit, -l         The number of tests to return  [string] [default: 10]

Run a test locally with headless support

mabl tests run

Options:
  --version, -v                               Show version number  [boolean]
  --help, -h                                  Show help  [boolean]
  --id                                        The id of the test to run  [string]
  --run-id                                    The id of the test run to pull config from  [string]
  --from-plan-id                              The plan id to get a list of tests from.
                                              Note: running tests with the --from-plan-id option is not a plan run. Advanced plan configurations, such as stages, browser settings or shared variables, are not applied.  [string]
  --mabl-branch                               Mabl branch to run test against  [string]
  --branch-changes-only                       Only execute tests changed on specified mabl branch  [boolean] [default: false]
  --labels                                    Space delimited test labels. Run tests that match any label.  [array]
  --exclude-labels                            Space delimited test labels. Exclude tests that match any label.  [array]
  --workspace-id, -w                          Workspace to run against  [string]
  --application-id, -a                        Mabl application used to report test results.  [string]
  --environment-id, -e                        Mabl environment to run under. Specify to ensure the test runs with environment variables and the latest find information.
                                              Note: Setting the environment does not override the default URL. Please use the (—url) command to override the URL.  [string]
  --locale                                    Locale to run the test in, e.g. en-US  [string]
  --timezone-id                               Identifier of the timezone to run the test in, e.g. America/Buenos_Aires  [string]
  --width                                     Set the browser width in pixels  [number] [default: 1080]
  --height                                    Set the browser height in pixels  [number] [default: 1440]
  --url, -u                                   URL to run the mabl test against  [string]
  --credentials-id, --creds                   Credentials ID to run the test with  [string]
  --data-table-id                             Run test using all the scenarios from the Data table ID  [string]
  --scenario-id                               Run test using an specific scenario  [string]
  --basic-auth-credentials-id, --basic-creds  Basic Authentication credentials for adding basic auth headers to test run  [string]
  --headless                                  Should the test run headless or not  [boolean] [default: false]
  --highlights                                Highlight elements before interacting with them. Highlighting introduces a small delay for each step.  [boolean] [default: false]
  --keep-browser-open                         Prevent the browser from closing at the end of a test.  [boolean] [default: false]
  --reporter                                  Output test run information with specified reporter.  [string] [choices: "mochawesome", "mabl"]
  --enable-browser-extensions                 Enable browser extensions on [Chrome] and [Edge]  [boolean] [default: false]
  --http-headers                              Space delimited HTTP headers added to browser requests (e.g. "x-header:foo")  [array]
  --user-agent                                Emulates a custom user-agent (e.g. "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4651.0 Safari/537.36")  [string]
  --interaction-speed                         Set the speed that mabl interacts with webpages. Overrides test run settings if specified.  [string] [choices: "fast", "normal", "slow", "slower"]
  --allow-billable-features                   Allow execution of billable features like AI assertions in CLI runs  [boolean] [default: false]
  --artifacts-dir                             Directory to write observation artifacts (screenshots). Defaults to a temp directory.  [string]
Examples:
  mabl tests run --id {id} --headless    run test locally by id in headless mode
  mabl tests run --run-id {test-run-id}  run a test locally using the test configuration from a cloud run

Run test(s) in the mabl cloud

mabl tests run-cloud

Options:
  --version, -v                               Show version number  [boolean]
  --help, -h                                  Show help  [boolean]
  --id                                        The id of the test to run  [string]
  --deployment-id, -d                         Deployment to run the mabl tests against  [string]
  --url, -u                                   Alias for app-url  [string]
  --app-url                                   Application/web URL to run the mabl test against  [string]
  --api-url                                   API URL to run the mabl test against  [string]
  --basic-auth-credentials-id, --basic-creds  Basic Authentication credentials to run the test with  [string]
  --browsers, -b                              Space delimited browsers to test against (e.g. "chrome edge firefox")  [array] [required] [choices: "chrome", "edge", "firefox", "webkit"] [default: "chrome"]
  --api-key, -k                               API key (found in the mabl web app)  [string]
  --mabl-branch                               Mabl branch to run test against  [string]
  --branch-changes-only                       Only execute tests changed on specified branch  [boolean] [default: false]
  --revision, --rev                           Code revision hash (application under test)  [string]
  --labels                                    Space delimited test labels. Run tests that match any label.  [array]
  --exclude-labels                            Space delimited test labels. Exclude tests that match any label.  [array]
  --workspace-id, -w                          Workspace to run against  [string]
  --application-id, -a                        Mabl application to run under. Specify to ensure the test runs with the right URLs. Consider also using the environment-id flag.  [string]
  --environment-id, -e                        Mabl environment to run under. Specify to ensure the test runs with environment variables and the latest find information. Consider also using the application-id flag.  [string]
  --credentials-id, --creds                   Credentials ID to run the test with  [string]
  --locale                                    Locale to run the test in, e.g. en-US  [string]
  --timezone-id                               Identifier of the timezone to run the test in, e.g. America/Buenos_Aires  [string]
  --prompt                                    Prompt to confirm execution selections  [boolean] [default: true]
  --no-prompt, --yes                          Do not prompt to confirm execution selections
Examples:
  mabl tests run-cloud --id {id}                   run test by id
  mabl tests run-cloud --labels {label1} {label2}  run tests by test label

Run a mobile test locally

mabl tests run-mobile

Options:
  --version, -v                  Show version number  [boolean]
  --help, -h                     Show help  [boolean]
  --id                           The id of the test to run  [string]
  --build-file-path, --app-file  The path to the mobile application binary  [string]
  --build-file-id                The ID of a previously uploaded mobile app file  [string]
  --platform                     The mobile platform  [string] [choices: "android", "ios"] [default: inferred from app binary extension]
  --workspace-id, -w             Workspace to run against  [string]
  --credentials-id, --creds      Credentials ID to run the test with  [string]
  --environment-id, -e           Mabl environment to run under. Specify to ensure the test runs with environment variables.  [string]
  --from-plan-id                 The plan id to get a list of tests from.
                                 Note: running tests with the --from-plan-id option is not a plan run. Advanced plan configurations, such as stages, browser settings or shared variables, are not applied.  [string]
  --run-id                       The id of the test run to pull config from  [string]
  --device                       Full name of the device to use for the test  [string]
  --mabl-branch                  Mabl branch to run test against  [string]
  --branch-changes-only          Only execute tests changed on specified mabl branch  [boolean] [default: false]
  --labels                       Space delimited test labels. Run tests that match any label.  [array]
  --exclude-labels               Space delimited test labels. Exclude tests that match any label.  [array]
  --allow-billable-features      Allow execution of billable features like AI assertions in CLI runs  [boolean] [default: false]
Examples:
  mabl tests run-mobile --id {id} --app-file {path} --platform {platform}  run mobile test locally by id

List users from a workspace

mabl users list

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --workspace-id, -w  Workspace to list users for  [string]
  --limit, -l         The number of users to return'  [string] [default: 10]
  --output, -o        Specify result output format  [choices: "json", "yaml"]

copy data from one workspace to another

mabl workspaces copy

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --from              The workspace from which to copy  [required]
  --to                The workspace the data will be copied into  [required]
  --include-defaults  Include default tests when copying  [boolean] [default: false]
  --included-tests    List of test ids to include with the copy. If empty, all tests will be copied.  [array] [default: []]
  --excluded-tests    List of test ids to exclude from the copy. If a test is in both the include and exclude list, it will be excluded.  [array] [default: []]

Describe a specific workspace

mabl workspaces describe {id}

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]
  --output, -o   Specify output format  [choices: "json", "yaml"]

List your workspaces

mabl workspaces list

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]
  --limit, -l    The number of workspaces to return  [default: 10]
  --output, -o   Specify result output format  [choices: "json", "yaml"]