Skip to content

Config reference

Generated by bun scripts/gen-config-reference.ts from the canonical zod schema in @actup/core (configJsonSchema()). Do not edit by hand — edit packages/core/src/config.ts and regenerate.

Config is discovered from (first hit wins): actup.json, .actup.json, .config/actup.json, then the .toml equivalents, then $XDG_CONFIG_HOME/actup/config.json (default ~/.config/actup/config.json). Missing config is not an error — defaults apply.

<key> denotes an arbitrary map key (e.g. a host name under hosts). [] denotes array-element fields. overrides[].policy.* is a partial overlay: an omitted key has no default — it inherits the resolved base policy for the matched action.

PathTypeRequiredDefaultConstraints
defaultHoststringnogithub.com
fetchobjectno
fetch.apiModegraphql | restnographql
fetch.maxTagsPerRepointegerno20min 1, max 255
fetch.cacheTtlintegerno3600min 0
fetch.offlinebooleannofalse
hostsmap<string, object>no{}
hosts.<key>objectno
hosts.<key>.kindgithub | gitlab | giteayes
hosts.<key>.apiBasestring (uri)no
hosts.<key>.tokenEnvstringnominLength 1
policyobjectno
policy.trackkeep | major | exactnomajor
policy.pinkeep | tag | shanokeep
policy.bumppatch | minor | major | latestnomajor
scanobjectno{}
scan.patternsarray<string>no
scan.ignorearray<string>no
scan.extraPathsarray<string>no
outputobjectno
output.formathuman | json | sarifnohuman
output.githubAnnotationsbooleannofalse
overridesarray<object>no[]
overrides[]objectno
overrides[].patternstringyesminLength 1
overrides[].policyobjectyes
overrides[].policy.trackkeep | major | exactno
overrides[].policy.pinkeep | tag | shano
overrides[].policy.bumppatch | minor | major | latestno