rwx run

Start a new run on RWX.

rwx run enables you to test workflows locally without committing and pushing changes. It automatically includes changes to run definitions and local code changes via git patching. For more details on local testing workflows, see CLI Triggers.

Usage

rwx run <file> [flags]

Examples

Running all tasks defined in .rwx/ci.yml:

rwx run .rwx/ci.yml

Running a specific task named test, and all of its dependencies, defined in .rwx/ci.yml:

rwx run .rwx/ci.yml --target test

Waiting for a run to complete and reporting the result:

rwx run .rwx/ci.yml --wait

Arguments

<file> (required)

The path to a specific RWX run definition file to run.

Options

--target <task-key>

The name of a specific task to run, along with all of its dependencies. If not provided, RWX will execute all tasks in the file. You can specific --target multiple times to target multiple tasks and their dependencies.

--dir <definitions-directory>

The directory that contains your run definitions. By default, the CLI will look for .rwx in the current directory and traverse upward until it finds a .rwx directory.

--init <key=value>

Initialization parameters for the run which will be made available in the init context. You can specify --init multiple times.

--no-cache

Do not read from the cache during the RWX run.

--open

Automatically open the run's results in your default browser.

--title <title>

The title to use for the run in the RWX UI.

--debug

Poll until a rwx-breakpoint is triggered in the run and then automatically start a remote debugging session connected to that breakpoint.

--wait

Poll until the run completes or reaches its first failure, then report additional details.

Global Options

--output <format>

Output format: text or json. Defaults to text.

Example JSON output:

{
  "RunId": "ee9fedf84db04b0392e9f1f58d9ad29c",
  "RunURL": "https://cloud.rwx.com/mint/rwx/runs/ee9fedf84db04b0392e9f1f58d9ad29c",
  "TargetedTaskKeys": ["test"],
  "DefinitionPath": ".rwx/ci.yml",
  "Message": "Run is watchable at https://cloud.rwx.com/mint/rwx/runs/ee9fedf84db04b0392e9f1f58d9ad29c",
  "ResultStatus": "succeeded"
}

The ResultStatus field is only present when using --wait.

--access-token <token>

The access token for RWX. Defaults to the value of the $RWX_ACCESS_TOKEN environment variable.