mabl CLI command reference

Start test authoring from a planning session or direct test information

mabl agent authoring initiate

Options:
  --version, -v          Show version number  [boolean]
  --help, -h             Show help  [boolean]
  --planning-session-id  Planning session ID from "mabl agent authoring plan". Mutually exclusive with --test-information.  [string]
  --test-information     JSON string with test information (name, test_case, deployment_id or url_override, etc.). Mutually exclusive with --planning-session-id.  [string]
  --plan                 Markdown test plan/outline. Only valid with --test-information.  [string]
  --test-type            Type of test to create.  [choices: "browser", "api"] [default: "browser"]
  --api-spec             API specification (OpenAPI/Swagger). Required when --test-type is api.  [string]
  --mode                 Execution mode. Cloud is recommended (parallelizable). Local is for testing locally running apps.  [choices: "cloud", "local"] [default: "cloud"]

Start or continue a test planning conversation with the mabl AI planning agent

mabl agent authoring plan

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]
  --intent       Detailed description of what the test should do. Required for starting a new session.  [string]
  --session-id   Planning session ID from a previous plan call. Required for follow-up changes.  [string]
  --changes      Changes to request for an existing plan. Requires --session-id.  [string]

Check the status of a test authoring session

mabl agent authoring status

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]
  --session-id   The agent session ID from "mabl agent authoring initiate".  [string] [required]
  --verbose      Show full details including latest agent message and test URL. Without this flag, only the status enum is returned for minimal output.  [boolean] [default: false]

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. Note: console / network artifacts are typically a single JSON line, so --head N will return the whole blob; use --query for JSON, --bytes for a fixed-byte prefix. Mutually exclusive with --tail/--bytes/--print/--query/--text-only  [number]
  --tail         Stream the last N lines of the cached artifact to stdout. Same caveat as --head: single-line JSON artifacts ignore line counts. 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]

Print every subcommand under this group as a structured tree, including positionals and flags. Run `<subcommand> --help` for the formatted yargs help text.

mabl agent debug command-list

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

Print every subcommand under this group as a structured tree, including positionals and flags. Run `<subcommand> --help` for the formatted yargs help text.

mabl agent debug session command-list

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

Print current variable context as JSON. Sources from state.json when available (the canonical-tree store the rest of the debug surface speaks); falls back to session.json for legacy sessions.

mabl agent debug session get-variables {session-id}

Positionals:
  session-id  Debug session id (returned by `session start`).  [string] [required]

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

List the steps in the debug session with their execution status. Output is YAML by default; pass --output json for the machine-readable form. EvaluateFlow / StepGroup children are expanded inline. Each entry carries a 1-based dot-notation `position` (e.g. "3.2") that `set-current-step` accepts.

mabl agent debug session list-steps {session-id}

Positionals:
  session-id  Debug session ID  [string] [required]

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]
  --filter       Case-insensitive substring match against the step description. Use to grep for "Application", "login", etc. without piping through grep.  [string]
  --around       Show only the window of steps around the given step. Accepts a step id OR a 1-based position ("3", "4.1"). Use --context N to widen (default 5 before / 5 after).  [string]
  --from         Show steps starting at the given step. Accepts a step id OR a 1-based position ("3", "4.1"). Combine with --limit to bound the window.  [string]
  --limit        Cap the number of steps in the output. Combine with --from for a forward window.  [number]
  --context      Window size for --around. Default 5 steps before and 5 after the target.  [number] [default: 5]
  --output, -o   Output format (json | yaml).  [choices: "json", "yaml"] [default: "yaml"]

Run all remaining steps from current position to end, stopping on first failure

mabl agent debug session run-all {session-id}

Positionals:
  session-id  Debug session id (returned by `session start`).  [string] [required]

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

Execute a step in the debug session. Pass <step-ref> to run a specific step; omit it to run the step at the canonical-tree cursor (the same position list-steps shows as isCursor and set-current-step writes to). A <step-ref> can be the canonical step id, the 1-based flat position from list-steps (e.g. "14"), dot-notation through the step tree (e.g. "3.2"), or the synthetic "<flow-id>:<idx>" id list-steps falls back to when the underlying flow has no json_steps ids.

mabl agent debug session run-step {session-id} [step-id]

Positionals:
  session-id  Debug session id (returned by `session start`).  [string] [required]
  step-id     Step reference: canonical step id, 1-based flat position (e.g. "14"), dot-notation (e.g. "3.2"), or synthetic "{flow-id}:{idx}". Omit to run the step at the cursor.  [string]

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

Run all steps from current position to the target step (inclusive), stopping on first failure. <step-ref> accepts the canonical step id, the 1-based flat position from list-steps (e.g. "14"), dot-notation (e.g. "3.2"), or the synthetic "<flow-id>:<idx>" fallback.

mabl agent debug session run-to-step {session-id} {step-id}

Positionals:
  session-id  Debug session id (returned by `session start`).  [string] [required]
  step-id     Target step reference: canonical step id, 1-based flat position (e.g. "14"), dot-notation (e.g. "3.2"), or synthetic "{flow-id}:{idx}".  [string] [required]

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

Move the execution cursor to a step (no execution — agent owns browser state). Accepts a step id or 1-based dot-notation position (e.g. "3.2").

mabl agent debug session set-current-step {session-id} {step-id}

Positionals:
  session-id  Debug session id (returned by `session start`).  [string] [required]
  step-id     Step id (UUID) OR 1-based dot-notation position (e.g. "3.2"). Nested addressing ("3.2") requires step 3 to be a step-group / reusable-flow wrapper; for a leaf, use the bare position ("3"). Run `list-steps` to discover both shapes.  [string] [required]

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

Start a debug session for a test

mabl agent debug session start [test-id]

Positionals:
  test-id  The ID of the test to debug, e.g. abc123-j. Optional when --run-id is given (the test id and most flags are then derived from the run).  [string]

Options:
  --version, -v                               Show version number  [boolean]
  --help, -h                                  Show help  [boolean]
  --environment-id, -e                        Mabl environment ID to load environment variables from. Setting the environment does not override the default URL — use --url for that.  [string]
  --url, -u                                   URL to run the test against  [string]
  --credentials-id, --creds                   Credentials ID to run the test with  [string]
  --basic-auth-credentials-id, --basic-creds  Basic Authentication credentials ID for adding basic auth headers to the test run  [string]
  --browser                                   Target browser for the test run. One of chrome, edge, firefox, webkit. Defaults to chrome.  [string] [choices: "chrome", "edge", "firefox", "webkit"]
  --width                                     Browser viewport width in pixels  [number] [default: 1080]
  --height                                    Browser viewport height in pixels  [number] [default: 1440]
  --locale                                    Locale to emulate, e.g. en-US  [string]
  --timezone-id                               Timezone identifier to emulate, e.g. America/New_York  [string]
  --user-agent                                Emulate a custom User-Agent string (e.g. "Mozilla/5.0 …")  [string]
  --interaction-speed                         Speed at which mabl interacts with web pages. Overrides test run settings if specified.  [string] [choices: "fast", "normal", "slow", "slower"]
  --mabl-branch                               Mabl branch to load test and flows from  [string]
  --headless                                  Run the browser in headless mode  [boolean] [default: false]
  --run-id                                    A test run ID (e.g. abc123-jr) to derive flags from. Sets test-id, url, browser, credentials, environment, locale and timezone from the run; explicit flags override.  [string]
  --port                                      Remote debugging port for Chrome. Defaults to 9222 so it lines up with the chrome-for-mabl MCP server entry. Pass 0 to let Chrome pick a free port.  [number] [default: 9222]

Kill the debug Chrome process and delete the session directory

mabl agent debug session stop {session-id}

Positionals:
  session-id  Debug session id (returned by `session start`).  [string] [required]

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

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]
  --output, -o   Output format (json | yaml).  [choices: "json", "yaml"] [default: "yaml"]

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: agents-md, claude, copilot, cursor, vscode)  [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: "project", "user"] [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]

Refresh tracked agent skills after upgrading the CLI

mabl agent update

Options:
  --version, -v  Show version number  [boolean]
  --help, -h     Show help  [boolean]
  --target       Only update installations for this target (agents-md, claude, copilot, cursor, vscode)  [string] [choices: "agents-md", "claude", "copilot", "cursor", "vscode"]
  --scope        Only update installations at this scope (project or user)  [string] [choices: "project", "user"]
  --yes, -y      Update every matching stale installation without prompting  [boolean] [default: false]
  --quiet        Suppress informational output; only print prune notices, errors, and the final summary when an update actually happened  [boolean] [default: false]

Create a new agent instruction

mabl agent-instructions create

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --workspace-id, -w  Workspace to create instruction in  [string]
  --name, -n          Name for the instruction  [string] [required]
  --instruction-text  The instruction text (max 1000 characters)  [string] [required]
  --capabilities      Capabilities to scope to (authoring, recovery, results_analysis)  [array]
  --application-ids   Application IDs to scope the instruction to  [array]
  --environment-ids   Environment IDs to scope the instruction to  [array]
  --disabled          Create the instruction in a disabled state  [boolean] [default: false]

Delete an agent instruction

mabl agent-instructions delete {id}

Positionals:
  id  The instruction ID  [string] [required]

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

Describe an agent instruction

mabl agent-instructions describe {id}

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

List agent instructions

mabl agent-instructions list

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

Update an agent instruction

mabl agent-instructions update {id}

Positionals:
  id  The instruction ID  [string] [required]

Options:
  --version, -v       Show version number  [boolean]
  --help, -h          Show help  [boolean]
  --name              Updated name  [string]
  --instruction-text  Updated instruction text  [string]
  --capabilities      Updated capabilities (authoring, recovery, results_analysis)  [array]
  --application-ids   Updated application IDs  [array]
  --environment-ids   Updated environment IDs  [array]
  --disabled          Disable the instruction  [boolean]
  --enabled           Enable the instruction  [boolean]

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]

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"]
  --platform          Filter results to a single mobile platform  [string] [choices: "android", "ios"]

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

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"]