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)
| Option | Description | Source |
|---|---|---|
--action-cache-path string | Defines the path where the actions get cached and host workspaces created. | help |
--action-offline-mode | If action contents exists, it will not be fetch and pull again. | help |
-a, --actor string | user that triggered the event (default "nektos/act") | help |
--artifact-server-addr string | Address the artifact server binds to. | help |
--artifact-server-path string | Defines the path where the artifact server stores uploads and retrieves downloads from. | help |
--artifact-server-port string | Defines the port where the artifact server listens. | help |
-b, --bind | bind working directory to container, rather than copy | help |
--bug-report | Display system information for bug report | help |
--cache-server-addr string | Defines the address to which the cache server binds. | help |
--cache-server-external-url string | Defines the external URL for if the cache server is behind a proxy. | help |
--cache-server-path string | Defines the path where the cache server stores caches. | help |
--cache-server-port uint16 | Defines the port where the artifact server listens. | help |
--concurrent-jobs int | Maximum number of concurrent jobs to run. | help |
--container-architecture string | Architecture which should be used to run containers, e.g.: linux/amd64. | help |
--container-cap-add stringArray | kernel capabilities to add to the workflow containers (e.g. --container-cap-add SYS_PTRACE) | help |
--container-cap-drop stringArray | kernel capabilities to remove from the workflow containers (e.g. --container-cap-drop SYS_PTRACE) | help |
--container-daemon-socket string | URI to Docker Engine socket (e.g.: unix://~/.docker/run/docker.sock or - to disable bind mounting the socket) | help |
--container-options string | Custom docker container options for the job container without an options property in the job definition | help |
--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") | help |
--defaultbranch string | the name of the main branch | help |
--detect-event | Use first event type from workflow as event that triggered the workflow | help |
-C, --directory string | working directory (default ".") | help |
-n, --dryrun | disable container creation, validates only workflow correctness | help |
--env stringArray | env to make available to actions with optional value (e.g. --env myenv=foo or --env myenv) | help |
--env-file string | environment file to read and use as env in the containers (default ".env") | help |
-e, --eventpath string | path to event JSON file | help |
--github-instance string | GitHub instance to use. | help |
-g, --graph | draw workflows | help |
-h, --help | help for act | help |
--input stringArray | action input to make available to actions (e.g. --input myinput=foo) | help |
--input-file string | input file to read and use as action input (default ".input") | help |
--insecure-secrets | NOT RECOMMENDED! Doesn't hide secrets while printing logs. | help |
-j, --job string | run a specific job ID | help |
--json | Output logs in json format | help |
-l, --list | list workflows | help |
--list-options | Print a json structure of compatible options | help |
--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) | help |
--log-prefix-job-id | Output the job id within non-json logs instead of the entire name | help |
--man-page | Print a generated manual page to stdout | help |
--matrix stringArray | specify which matrix configuration to include (e.g. --matrix java:13 | help |
--network string | Sets a docker network name. | help |
--no-cache-server | Disable cache server | help |
--no-recurse | Flag to disable running workflows from subdirectories of specified path in '--workflows'/'-W' flag | help |
--no-skip-checkout | Use actions/checkout instead of copying local files into container | help |
-P, --platform stringArray | custom image to use per platform (e.g. -P ubuntu-18.04=nektos/act-environments-ubuntu:18.04) | help |
--privileged | use privileged mode | help |
-p, --pull | pull docker image(s) even if already present (default true) | help |
-q, --quiet | disable logging of output from steps | help |
--rebuild | rebuild local action docker image(s) even if already present (default true) | help |
--remote-name string | git remote name that will be used to retrieve url of git repo (default "origin") | help |
--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 | help |
--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. | help |
-r, --reuse | don't remove container(s) on successfully completed workflow(s) to maintain state between runs | help |
--rm | automatically remove container(s)/volume(s) after a workflow(s) failure | help |
-s, --secret stringArray | secret to make available to actions with optional value (e.g. -s mysecret=foo or -s mysecret) | help |
--secret-file string | file with list of secrets to read from (e.g. --secret-file .secrets) (default ".secrets") | help |
--strict | use strict workflow schema | help |
--trust-project-actrc | Apply every flag in ./.actrc. | help |
--use-gitignore | Controls whether paths specified in .gitignore should be copied into container (default true) | help |
--use-new-action-cache | Enable using the new Action Cache for storing Actions locally | help |
--userns string | user namespace to use | help |
--validate | validate workflows | help |
--var stringArray | variable to make available to actions with optional value (e.g. --var myvar=foo or --var myvar) | help |
--var-file string | file with list of vars to read from (e.g. --var-file .vars) (default ".vars") | help |
-v, --verbose | verbose output | help |
--version | version for act | help |
-w, --watch | watch the contents of the local repo and run when files change | help |
-W, --workflows string | path to workflow file(s) (default "./.github/workflows/") | help |