Skip to content

Latest commit

 

History

History
96 lines (62 loc) · 4.62 KB

README.md

File metadata and controls

96 lines (62 loc) · 4.62 KB
Raw

Build Status Gitter NuGet Azure DevOps coverage

NuKeeper

Why is NuKeeper Archived

Automagically update NuGet packages in all .NET projects.

Installation

Installation is very easy. Just run this command and the tool will be installed.

Install: dotnet tool install nukeeper --global

Note: NuKeeper has experimental support for running package updates on Linux/macOS. This functionality relies on Mono installation on local system. Please refer to https://www.mono-project.com/ for more information about how to install mono.

Platform support

NuKeeper works for .NET Framework and for .NET Core projects. It also has the ability to target private NuGet feeds.

.NET Framework .NET Core Private Nuget Feed
✔️ ✔️ ✔️

Integration with the following platforms is supported.

Github AzureDevOps BitBucket GitLab Gitea
✔️ ✔️ ✔️ ✔️ ✔️

Commands

NuKeeper has different commands and options which can be utilized. Below you'll find a summary of all the commands and what they do.

Options:
  --version     Show version information
  -?|-h|--help  Show help information

Commands:
  global        Performs version checks and generates pull requests for all repositories the provided token can access.
  inspect       Checks projects existing locally for possible updates.
  org           Performs version checks and generates pull requests for all repositories in a github organisation.
  repo          Performs version checks and generates pull requests for a single repository.
  update        Applies relevant updates to a local project.

For detailed information about the commands, please check out the wiki

How To Uninstall

You can uninstall the tool using the following command.

dotnet tool uninstall nukeeper --global

How To Build and Run From Source

You can install the nukeeper dotnet tool of current build using the InstallNuKeeperDotNetTool (.bat for Windows, .sh for macOS and Linux) found in the root of the repository.

Note: this overrides your existing global installation of the NuKeeper dotnet tool.

You can build and package the tool using the following commands. The instructions assume that you are in the root of the repository.

dotnet pack .\NuKeeper\NuKeeper.csproj -o ".\artifacts"
dotnet tool install nukeeper --global --add-source ".\artifacts"
nukeeper --version

Note: On macOS and Linux, .\NuKeeper\NuKeeper.csproj and .\artifacts will need be switched to ./NuKeeper/NuKeeper.csproj and ./artifacts to accommodate for the different slash directions.

Licensing

NuKeeper is licensed under the Apache License

Acknowledgements

Logos by area55, licensed under a Creative Commons Attribution 4.0 International License.