OS Manuals

/usr/bin/act

Run your GitHub Actions locally

From act 0.2.97-r0 (os), captured 2026-11-05 by running act --help (exit 0). permalink

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

Usage:
  act [event name to run] [flags]

If no event name passed, will default to "on: push"
If actions handles only one event it will be used as default instead of "on: push"

Flags:
      --action-cache-path string                          Defines the path where the actions get cached and host workspaces created. (default "/tmp/.cache/act")
      --action-offline-mode                               If action contents exists, it will not be fetch and pull again. If turn on this, will turn off force pull
  -a, --actor string                                      user that triggered the event (default "nektos/act")
      --artifact-server-addr string                       Address the artifact server binds to. When omitted, Linux host-network jobs use 127.0.0.1 and every other container network uses the outbound address. (default "127.0.0.1")
      --artifact-server-path string                       Defines the path where the artifact server stores uploads and retrieves downloads from. If not specified the artifact server will not start.
      --artifact-server-port string                       Defines the port where the artifact server listens. (default "34567")
  -b, --bind                                              bind working directory to container, rather than copy
      --bug-report                                        Display system information for bug report
      --cache-server-addr string                          Defines the address to which the cache server binds. (default "<nil>")
      --cache-server-external-url string                  Defines the external URL for if the cache server is behind a proxy. e.g.: https://act-cache-server.example.com. Be careful that there is no trailing slash.
      --cache-server-path string                          Defines the path where the cache server stores caches. (default "/tmp/.cache/actcache")
      --cache-server-port uint16                          Defines the port where the artifact server listens. 0 means a randomly available port.
      --concurrent-jobs int                               Maximum number of concurrent jobs to run. Default is the number of CPUs available.
      --container-architecture string                     Architecture which should be used to run containers, e.g.: linux/amd64. If not specified, will use host default architecture. Requires Docker server API Version 1.41+. Ignored on earlier Docker server platforms.
      --container-cap-add stringArray                     kernel capabilities to add to the workflow containers (e.g. --container-cap-add SYS_PTRACE)
      --container-cap-drop stringArray                    kernel capabilities to remove from the workflow containers (e.g. --container-cap-drop SYS_PTRACE)
      --container-daemon-socket string                    URI to Docker Engine socket (e.g.: unix://~/.docker/run/docker.sock or - to disable bind mounting the socket)
      --container-options string                          Custom docker container options for the job container without an options property in the job definition
      --container-options-policy string                   Policy for container options and host path volumes set by workflows: auto restricts them when --container-daemon-socket is -, restrict always restricts them, allow permits them (default "auto")
      --defaultbranch string                              the name of the main branch
      --detect-event                                      Use first event type from workflow as event that triggered the workflow
  -C, --directory string                                  working directory (default ".")
  -n, --dryrun                                            disable container creation, validates only workflow correctness
      --env stringArray                                   env to make available to actions with optional value (e.g. --env myenv=foo or --env myenv)
      --env-file string                                   environment file to read and use as env in the containers (default ".env")
  -e, --eventpath string                                  path to event JSON file
      --github-instance string                            GitHub instance to use. Only use this when using GitHub Enterprise Server. (default "github.com")
  -g, --graph                                             draw workflows
  -h, --help                                              help for act
      --input stringArray                                 action input to make available to actions (e.g. --input myinput=foo)
      --input-file string                                 input file to read and use as action input (default ".input")
      --insecure-secrets                                  NOT RECOMMENDED! Doesn't hide secrets while printing logs.
  -j, --job string                                        run a specific job ID
      --json                                              Output logs in json format
  -l, --list                                              list workflows
      --list-options                                      Print a json structure of compatible options
      --local-repository stringArray                      Replaces the specified repository and ref with a local folder (e.g. https://github.com/test/test@v0=/home/act/test or test/test@v0=/home/act/test, the latter matches any hosts or protocols)
      --log-prefix-job-id                                 Output the job id within non-json logs instead of the entire name
      --man-page                                          Print a generated manual page to stdout
      --matrix stringArray                                specify which matrix configuration to include (e.g. --matrix java:13
      --network string                                    Sets a docker network name. Defaults to host. (default "host")
      --no-cache-server                                   Disable cache server
      --no-recurse                                        Flag to disable running workflows from subdirectories of specified path in '--workflows'/'-W' flag
      --no-skip-checkout                                  Use actions/checkout instead of copying local files into container
  -P, --platform stringArray                              custom image to use per platform (e.g. -P ubuntu-18.04=nektos/act-environments-ubuntu:18.04)
      --privileged                                        use privileged mode
  -p, --pull                                              pull docker image(s) even if already present (default true)
  -q, --quiet                                             disable logging of output from steps
      --rebuild                                           rebuild local action docker image(s) even if already present (default true)
      --remote-name string                                git remote name that will be used to retrieve url of git repo (default "origin")
      --replace-ghe-action-token-with-github-com string   If you are using replace-ghe-action-with-github-com  and you want to use private actions on GitHub, you have to set personal access token
      --replace-ghe-action-with-github-com stringArray    If you are using GitHub Enterprise Server and allow specified actions from GitHub (github.com), you can set actions on this. (e.g. --replace-ghe-action-with-github-com =github/super-linter)
  -r, --reuse                                             don't remove container(s) on successfully completed workflow(s) to maintain state between runs
      --rm                                                automatically remove container(s)/volume(s) after a workflow(s) failure
  -s, --secret stringArray                                secret to make available to actions with optional value (e.g. -s mysecret=foo or -s mysecret)
      --secret-file string                                file with list of secrets to read from (e.g. --secret-file .secrets) (default ".secrets")
      --strict                                            use strict workflow schema
      --trust-project-actrc                               Apply every flag in ./.actrc. Without it, ./.actrc may only set flags that do not reach host resources, and $VAR references in it are not expanded. Set it on the command line or in your user config.
      --use-gitignore                                     Controls whether paths specified in .gitignore should be copied into container (default true)
      --use-new-action-cache                              Enable using the new Action Cache for storing Actions locally
      --userns string                                     user namespace to use
      --validate                                          validate workflows
      --var stringArray                                   variable to make available to actions with optional value (e.g. --var myvar=foo or --var myvar)
      --var-file string                                   file with list of vars to read from (e.g. --var-file .vars) (default ".vars")
  -v, --verbose                                           verbose output
      --version                                           version for act
  -w, --watch                                             watch the contents of the local repo and run when files change
  -W, --workflows string                                  path to workflow file(s) (default "./.github/workflows/")
Options (68)
OptionDescriptionSource
--action-cache-path stringDefines the path where the actions get cached and host workspaces created.help
--action-offline-modeIf action contents exists, it will not be fetch and pull again.help
-a, --actor stringuser that triggered the event (default "nektos/act")help
--artifact-server-addr stringAddress the artifact server binds to.help
--artifact-server-path stringDefines the path where the artifact server stores uploads and retrieves downloads from.help
--artifact-server-port stringDefines the port where the artifact server listens.help
-b, --bindbind working directory to container, rather than copyhelp
--bug-reportDisplay system information for bug reporthelp
--cache-server-addr stringDefines the address to which the cache server binds.help
--cache-server-external-url stringDefines the external URL for if the cache server is behind a proxy.help
--cache-server-path stringDefines the path where the cache server stores caches.help
--cache-server-port uint16Defines the port where the artifact server listens.help
--concurrent-jobs intMaximum number of concurrent jobs to run.help
--container-architecture stringArchitecture which should be used to run containers, e.g.: linux/amd64.help
--container-cap-add stringArraykernel capabilities to add to the workflow containers (e.g. --container-cap-add SYS_PTRACE)help
--container-cap-drop stringArraykernel capabilities to remove from the workflow containers (e.g. --container-cap-drop SYS_PTRACE)help
--container-daemon-socket stringURI to Docker Engine socket (e.g.: unix://~/.docker/run/docker.sock or - to disable bind mounting the socket)help
--container-options stringCustom docker container options for the job container without an options property in the job definitionhelp
--container-options-policy stringPolicy for container options and host path volumes set by workflows: auto restricts them when --container-daemon-socket is -, restrict always restricts them, allow permits them (default "auto")help
--defaultbranch stringthe name of the main branchhelp
--detect-eventUse first event type from workflow as event that triggered the workflowhelp
-C, --directory stringworking directory (default ".")help
-n, --dryrundisable container creation, validates only workflow correctnesshelp
--env stringArrayenv to make available to actions with optional value (e.g. --env myenv=foo or --env myenv)help
--env-file stringenvironment file to read and use as env in the containers (default ".env")help
-e, --eventpath stringpath to event JSON filehelp
--github-instance stringGitHub instance to use.help
-g, --graphdraw workflowshelp
-h, --helphelp for acthelp
--input stringArrayaction input to make available to actions (e.g. --input myinput=foo)help
--input-file stringinput file to read and use as action input (default ".input")help
--insecure-secretsNOT RECOMMENDED! Doesn't hide secrets while printing logs.help
-j, --job stringrun a specific job IDhelp
--jsonOutput logs in json formathelp
-l, --listlist workflowshelp
--list-optionsPrint a json structure of compatible optionshelp
--local-repository stringArrayReplaces the specified repository and ref with a local folder (e.g. https://github.com/test/test@v0=/home/act/test or test/test@v0=/home/act/test, the latter matches any hosts or protocols)help
--log-prefix-job-idOutput the job id within non-json logs instead of the entire namehelp
--man-pagePrint a generated manual page to stdouthelp
--matrix stringArrayspecify which matrix configuration to include (e.g. --matrix java:13help
--network stringSets a docker network name.help
--no-cache-serverDisable cache serverhelp
--no-recurseFlag to disable running workflows from subdirectories of specified path in '--workflows'/'-W' flaghelp
--no-skip-checkoutUse actions/checkout instead of copying local files into containerhelp
-P, --platform stringArraycustom image to use per platform (e.g. -P ubuntu-18.04=nektos/act-environments-ubuntu:18.04)help
--privilegeduse privileged modehelp
-p, --pullpull docker image(s) even if already present (default true)help
-q, --quietdisable logging of output from stepshelp
--rebuildrebuild local action docker image(s) even if already present (default true)help
--remote-name stringgit remote name that will be used to retrieve url of git repo (default "origin")help
--replace-ghe-action-token-with-github-com stringIf you are using replace-ghe-action-with-github-com and you want to use private actions on GitHub, you have to set personal access tokenhelp
--replace-ghe-action-with-github-com stringArrayIf you are using GitHub Enterprise Server and allow specified actions from GitHub (github.com), you can set actions on this.help
-r, --reusedon't remove container(s) on successfully completed workflow(s) to maintain state between runshelp
--rmautomatically remove container(s)/volume(s) after a workflow(s) failurehelp
-s, --secret stringArraysecret to make available to actions with optional value (e.g. -s mysecret=foo or -s mysecret)help
--secret-file stringfile with list of secrets to read from (e.g. --secret-file .secrets) (default ".secrets")help
--strictuse strict workflow schemahelp
--trust-project-actrcApply every flag in ./.actrc.help
--use-gitignoreControls whether paths specified in .gitignore should be copied into container (default true)help
--use-new-action-cacheEnable using the new Action Cache for storing Actions locallyhelp
--userns stringuser namespace to usehelp
--validatevalidate workflowshelp
--var stringArrayvariable to make available to actions with optional value (e.g. --var myvar=foo or --var myvar)help
--var-file stringfile with list of vars to read from (e.g. --var-file .vars) (default ".vars")help
-v, --verboseverbose outputhelp
--versionversion for acthelp
-w, --watchwatch the contents of the local repo and run when files changehelp
-W, --workflows stringpath to workflow file(s) (default "./.github/workflows/")help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.