|Long name||Short name||Commands where it applies||Default value|
|source||s||all||NuGet.org public api url|
||GitHub.com public API Uri|
||Depends on repository Uri|
||3, or when the command is
||null (use default Lib2Git-Implementation)|
age The minimum package age. In order to not consume packages immediately after they are released, exclude updates that do not meet a minimum age. The default is 7 days. This age is the duration between the published date of the selected package update and now.
A value can be expressed in command options as an integer and a unit suffix,
where the unit is one of
h for hour,
d for days,
w for weeks. A zero with no unit is also allowed.
0 = zero,
12h = 12 hours,
3d = 3 days,
2w = two weeks.
change The greatest level of update that is allowed to packages, based on the version number difference. Values are:
See Semver for what these mean.
The default value
Major will allow updates to the overall latest version even if it means accepting a new major version.
For example, if you are currently using package
Foo at version
1.2.3 and these new versions are available:
1.2.4 - a patch version change,
1.3.0 - a minor version change and
2.0.0 - a new major version.
* If the allowed version change is
Major (the default) you will get an update to the overall latest version, i.e.
* If you set the allowed version change to
Minor, you will get an update to
1.3.0 as now changes to the major version number are not allowed. Version
1.2.4 is also allowed, but the largest allowed update is applied.
* If the allowed version change is
Patch you will only get an update to version
UsePrerelease Should NuKeeper suggest updates to a pre-release (beta) package version. Values are
FromPrerelease. The default is
FromPrerelease, meaning that only a package that is currently used at a pre-release version will be updated to a later pre-release version.
exclude Do not consider packages matching this regex pattern.
include Only consider packages matching this regex pattern.
source Specifies a NuGet package source to use during the operation. This setting overrides all of the sources specified in the
NuGet.config files. Multiple sources can be provided by specifying this option multiple times.
verbosity. Controls how much log data is produced. Values are, from least output to most output:
Quiet should produce no output unless there is an error, and
Detailed is suitable for debugging issues. You can also use short names for these log levels:
logdestination: Where log data is sent: One of:
Off. Default is
logfile when set, log data will be appended to the named file instead of going to console.
outputformat. Format for output. One of:
Libyears. Default is
outputdestination: Where output is sent: One of:
Off. Default is
outputfile : Name of file to send output to. Used when output destination is
File. default is
api This is the api endpoint for the instance you’re targeting. If you are using an internal server and not a public one, you must set it to the api url for your server. The value will be e.g.
fork Values are
SingleRepositoryOnly. Prefer to make branches on a fork of the target repository, or on that repository itself. See the section “Branches, forks and pull requests” below.
label Label to apply to GitHub pull requests. Can be specified multiple times.
maxpackageupdates The maximum number of package updates to apply. In
global commands, this limits the number of updates per repository. If the
--consolidate flag is used, these wll be consolidated into one Pull Request. If not, then there will be one Pull Request per update applied. In the
update command, The default value is 1. When changed, multiple updates can be applied in a single
update run, up to this number.
maxrepo The maximum number of repositories to change. Used in Organisation and Global mode.
consolidate Consolidate updates into a single pull request, instead of the default of 1 pull request per package update applied.
platform One of
Gitea. Determines which kind of source control api will be used. This is typicaly infered from the api url structure, but since this does not always work, it can be specified here if neccessary.
gitclipath Path to
git command line. Alternative use native git via cli instead of the default lib2gitsharp implementation. In special cases lib2gitsharp is not enough. E.g. in enviroments with company-proxies or self hosted git services signed certificates. For Windows it is typically
C:\Program Files\Git\bin\git.exe. For Linux it is typically
includerepos A regex to filter repositories by name. Only consider repositories where the name matches this regex pattern. Used in Organisation and Global mode.
excluderepos A regex to filter repositories by name. Do not consider repositories where the name matches this regex pattern. Used in Organisation and Global mode.
branchnameprefix A prefix that gets added to branch name that NuKeeper creates. Allows you to put those branches in hierarchy (E.G. ‘nukeeper/’).
deletebranchaftermerge Specifies whether a branch should be automatically deleted or not once the branch has been merged. Currently only works with
Platform equal to