Reference

apex run

Run a workflow locally with the same engine and executor as the service (wraps apex-runner --local)

apex run [options] [workflow]

Arguments
Argument	Description
`[workflow]`	workflow file to run (default: the only file in .github/workflows/)

Options
Option	Description
`--job <id>`	run only this job id (its needs are assumed satisfied)
`--event <name>`	event to plan against (default: push)
`--payload <file>`	JSON file with the event payload
`--secret <KEY[=value]>`	secret (repeatable): KEY alone reads the value from your environment, keeping it out of argv; GITHUB_TOKEN reaches the github context
`--var <KEY=value>`	repository variable (repeatable)
`--input <key=value>`	workflow_dispatch input (repeatable)
`--changed-file <path>`	changed file for paths filters (repeatable)
`--image <image>`	default job container image
`--json`	print the run result as JSON on stdout

Examples

Run a workflow on this machine with the same engine and executor as the service.

apex run .github/workflows/ci.yml

Run one job; NPM_TOKEN is read from your environment, never from the command line.

apex run --job test --secret NPM_TOKEN

Plan against a pull_request event with a payload you supply.

apex run --event pull_request --payload event.json