act

Run GitHub actions locally by specifying the event name (e.g. `push`) or an action name directly

Subcommands

NameDescription
completionGenerate the autocompletion script for the specified shell
helpHelp about any command

Options

NameDescription
--bind, -bBind working directory to container, rather than copy
--bug-reportDisplay system information for bug report
--container-cap-add <container-cap-add>
  • Repeatable ♾
--container-cap-drop <container-cap-drop>
  • Repeatable ♾
--defaultbranch <defaultbranch>The name of the main branch
--detect-eventUse first event type from workflow as event that triggered the workflow
--env <env>
  • Repeatable ♾
--eventpath, -e <eventpath>Path to event JSON file
--graph, -gDraw workflows
--job, -j <job>Run job
--list, -lList workflows
--platform, -P <platform>
  • Repeatable ♾
--privilegedUse privileged mode
--pull, -pPull docker image(s) even if already present
--rebuildRebuild local action docker image(s) even if already present
--remote-name <remote-name>Git remote name that will be used to retrieve url of git repo
--reuse, -rDon't remove container(s) on successfully completed workflow(s) to maintain state between runs
--rmAutomatically remove container(s)/volume(s) after a workflow(s) failure
--secret, -s <secret>
  • Repeatable ♾
--use-gitignoreControls whether paths specified in .gitignore should be copied into container
--userns <userns>User namespace to use
--watch, -wWatch the contents of the local repo and run when files change
--actor, -a <actor>
  • Persistent ⚖
--artifact-server-path <artifact-server-path>
  • Persistent ⚖
--artifact-server-port <artifact-server-port>
  • Persistent ⚖
--container-architecture <container-architecture>
  • Persistent ⚖
--container-daemon-socket <container-daemon-socket>
  • Persistent ⚖
--directory, -C <directory>
  • Persistent ⚖
--dryrun, -n
  • Persistent ⚖
--env-file <env-file>
  • Persistent ⚖
--github-instance <github-instance>
  • Persistent ⚖
--insecure-secrets
  • Persistent ⚖
--json
  • Persistent ⚖
--no-recurse
  • Persistent ⚖
--no-skip-checkout
  • Persistent ⚖
--quiet, -q
  • Persistent ⚖
--secret-file <secret-file>
  • Persistent ⚖
--verbose, -v
  • Persistent ⚖
--workflows, -W <workflows>
  • Persistent ⚖
--help, -h
  • Persistent ⚖