.nh
.TH "act" "1" "Jan 2025" "act 0.2.71" ""

.SH NAME
act - Run GitHub actions locally by specifying the event name (e.g. \fBpush\fR) or an action name directly.


.SH SYNOPSIS
**act [event name to run] [flags]

.PP
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"**


.SH DESCRIPTION
Run GitHub actions locally by specifying the event name (e.g. \fBpush\fR) or an action name directly.


.SH OPTIONS
\fB--action-cache-path\fP="/build/.cache/act"
	Defines the path where the actions get cached and host workspaces created.

.PP
\fB--action-offline-mode\fP[=false]
	If action contents exists, it will not be fetch and pull again. If turn on this, will turn off force pull

.PP
\fB-a\fP, \fB--actor\fP="nektos/act"
	user that triggered the event

.PP
\fB--artifact-server-addr\fP="162.55.28.166"
	Defines the address to which the artifact server binds.

.PP
\fB--artifact-server-path\fP=""
	Defines the path where the artifact server stores uploads and retrieves downloads from. If not specified the artifact server will not start.

.PP
\fB--artifact-server-port\fP="34567"
	Defines the port where the artifact server listens.

.PP
\fB-b\fP, \fB--bind\fP[=false]
	bind working directory to container, rather than copy

.PP
\fB--bug-report\fP[=false]
	Display system information for bug report

.PP
\fB--cache-server-addr\fP="162.55.28.166"
	Defines the address to which the cache server binds.

.PP
\fB--cache-server-path\fP="/build/.cache/actcache"
	Defines the path where the cache server stores caches.

.PP
\fB--cache-server-port\fP=0
	Defines the port where the artifact server listens. 0 means a randomly available port.

.PP
\fB--container-architecture\fP=""
	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.

.PP
\fB--container-cap-add\fP=[]
	kernel capabilities to add to the workflow containers (e.g. --container-cap-add SYS_PTRACE)

.PP
\fB--container-cap-drop\fP=[]
	kernel capabilities to remove from the workflow containers (e.g. --container-cap-drop SYS_PTRACE)

.PP
\fB--container-daemon-socket\fP=""
	URI to Docker Engine socket (e.g.: unix://~/.docker/run/docker.sock or - to disable bind mounting the socket)

.PP
\fB--container-options\fP=""
	Custom docker container options for the job container without an options property in the job definition

.PP
\fB--defaultbranch\fP=""
	the name of the main branch

.PP
\fB--detect-event\fP[=false]
	Use first event type from workflow as event that triggered the workflow

.PP
\fB-C\fP, \fB--directory\fP="."
	working directory

.PP
\fB-n\fP, \fB--dryrun\fP[=false]
	disable container creation, validates only workflow correctness

.PP
\fB--env\fP=[]
	env to make available to actions with optional value (e.g. --env myenv=foo or --env myenv)

.PP
\fB--env-file\fP=".env"
	environment file to read and use as env in the containers

.PP
\fB-e\fP, \fB--eventpath\fP=""
	path to event JSON file

.PP
\fB--github-instance\fP="github.com"
	GitHub instance to use. Only use this when using GitHub Enterprise Server.

.PP
\fB-g\fP, \fB--graph\fP[=false]
	draw workflows

.PP
\fB-h\fP, \fB--help\fP[=false]
	help for act

.PP
\fB--input\fP=[]
	action input to make available to actions (e.g. --input myinput=foo)

.PP
\fB--input-file\fP=".input"
	input file to read and use as action input

.PP
\fB--insecure-secrets\fP[=false]
	NOT RECOMMENDED! Doesn't hide secrets while printing logs.

.PP
\fB-j\fP, \fB--job\fP=""
	run a specific job ID

.PP
\fB--json\fP[=false]
	Output logs in json format

.PP
\fB-l\fP, \fB--list\fP[=false]
	list workflows

.PP
\fB--local-repository\fP=[]
	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)

.PP
\fB--log-prefix-job-id\fP[=false]
	Output the job id within non-json logs instead of the entire name

.PP
\fB--man-page\fP[=false]
	Print a generated manual page to stdout

.PP
\fB--matrix\fP=[]
	specify which matrix configuration to include (e.g. --matrix java:13

.PP
\fB--network\fP="host"
	Sets a docker network name. Defaults to host.

.PP
\fB--no-cache-server\fP[=false]
	Disable cache server

.PP
\fB--no-recurse\fP[=false]
	Flag to disable running workflows from subdirectories of specified path in '--workflows'/'-W' flag

.PP
\fB--no-skip-checkout\fP[=false]
	Do not skip actions/checkout

.PP
\fB-P\fP, \fB--platform\fP=[]
	custom image to use per platform (e.g. -P ubuntu-18.04=nektos/act-environments-ubuntu:18.04)

.PP
\fB--privileged\fP[=false]
	use privileged mode

.PP
\fB-p\fP, \fB--pull\fP[=true]
	pull docker image(s) even if already present

.PP
\fB-q\fP, \fB--quiet\fP[=false]
	disable logging of output from steps

.PP
\fB--rebuild\fP[=true]
	rebuild local action docker image(s) even if already present

.PP
\fB--remote-name\fP="origin"
	git remote name that will be used to retrieve url of git repo

.PP
\fB--replace-ghe-action-token-with-github-com\fP=""
	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

.PP
\fB--replace-ghe-action-with-github-com\fP=[]
	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)

.PP
\fB-r\fP, \fB--reuse\fP[=false]
	don't remove container(s) on successfully completed workflow(s) to maintain state between runs

.PP
\fB--rm\fP[=false]
	automatically remove container(s)/volume(s) after a workflow(s) failure

.PP
\fB-s\fP, \fB--secret\fP=[]
	secret to make available to actions with optional value (e.g. -s mysecret=foo or -s mysecret)

.PP
\fB--secret-file\fP=".secrets"
	file with list of secrets to read from (e.g. --secret-file .secrets)

.PP
\fB--use-gitignore\fP[=true]
	Controls whether paths specified in .gitignore should be copied into container

.PP
\fB--use-new-action-cache\fP[=false]
	Enable using the new Action Cache for storing Actions locally

.PP
\fB--userns\fP=""
	user namespace to use

.PP
\fB--var\fP=[]
	variable to make available to actions with optional value (e.g. --var myvar=foo or --var myvar)

.PP
\fB--var-file\fP=".vars"
	file with list of vars to read from (e.g. --var-file .vars)

.PP
\fB-v\fP, \fB--verbose\fP[=false]
	verbose output

.PP
\fB--version\fP[=false]
	version for act

.PP
\fB-w\fP, \fB--watch\fP[=false]
	watch the contents of the local repo and run when files change

.PP
\fB-W\fP, \fB--workflows\fP="./.github/workflows/"
	path to workflow file(s)


.SH HISTORY
1-Jan-2025 Auto generated by spf13/cobra