rwx dispatch

Dispatch a run using a dispatch trigger.

Usage

rwx dispatch <dispatch-key> [flags]

Examples

Dispatching a run on main with the key deploy and specifying the deployment-target param:

rwx dispatch deploy-application --param deployment-target=staging

Arguments

<dispatch-key> (required)

The key of the dispatch trigger to use for the run.

Options

--param <key=value>

Params for the dispatch which will be made available in the event.dispatch.params context. You can specify --param multiple times.

--ref <ref>

The git ref to use for the run and for the event.git context. You can specify a commit sha, a branch name (optionally prefixed with ref/heads), or a tag name (optionally prefixed with ref/tags). If not specified, your repository's default branch will be used.

The ref must exist on your remote repository and it must contain the dispatch trigger in it. The params specified with --param will be validated against the dispatch trigger as it exists on the ref. For example, if you push a feature branch which adds a dispatch trigger and then specify main for the ref before the feature branch is merged into main, the dispatch will not succeed. Likewise, if your dispatch trigger exists on main but you push a commit to a feature branch which changes the params of the dispatch trigger and then attempt to dispatch a run with --ref main using the params from the feature branch, the dispatch will not succeed.

--open

Automatically open the run in the Cloud UI in your default browser.

--title <title>

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

--debug

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

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

--access-token <token>

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