nukeeper/nukeeper

NuKeeper

镜像概述和主要用途

NuKeeper是一款专注于自动更新.NET项目中NuGet包的工具，旨在简化依赖管理流程。它能够自动检查项目中的NuGet包版本，识别可更新的依赖，并针对本地项目或远程仓库生成更新拉取请求，支持批量处理多个项目和仓库。

核心功能和特性

• 自动NuGet包更新：检测项目中NuGet依赖的新版本，自动生成更新建议或直接应用更新
• 多项目类型支持：兼容.NET Framework和.NET Core项目，满足不同.NET技术栈需求
• 私有源支持：可配置并访问私有NuGet feed，适用于企业内部项目
• 多平台集成：支持与主流代码托管平台集成，包括GitHub、Azure DevOps、BitBucket、GitLab和Gitea
• 灵活命令集：提供多种命令满足不同场景，从本地项目检查到组织级批量更新

平台支持

.NET项目类型支持

代码托管平台集成支持

注意：在Linux/macOS系统上运行需依赖Mono环境，具体安装方法请参考Mono官方文档。

命令说明

NuKeeper提供以下核心命令及选项，可通过命令行执行：

选项:
  --version     显示版本信息
  -?|-h|--help  显示帮助信息

命令:
  global        检查指定令牌可访问的所有仓库，生成更新拉取请求
  inspect       检查本地项目的可能更新
  org           检查GitHub组织中所有仓库，生成更新拉取请求
  repo          检查单个仓库，生成更新拉取请求
  update        对本地项目应用相关更新

https://github.com/NuKeeperDotNet/NuKeeper/wiki

安装与卸载

安装

通过dotnet工具命令全局安装：

console
dotnet tool install nukeeper --global

卸载

如需卸载NuKeeper工具，执行以下命令：

console
dotnet tool uninstall nukeeper --global

从源码构建和运行

安装当前构建版本

使用仓库根目录下的InstallNuKeeperDotNetTool脚本（Windows为.bat文件，macOS/Linux为.sh文件）可安装当前构建的工具版本，此操作会覆盖已有的全局NuKeeper安装。

手动构建和打包

在仓库根目录执行以下命令构建并安装：

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

注意：在macOS和Linux系统中，路径需使用斜杠格式，如./NuKeeper/NuKeeper.csproj和./artifacts。

许可信息

NuKeeper采用Apache License许可协议。

主要依赖组件许可：

• Git自动化：https://github.com/libgit2/libgit2sharp/%EF%BC%88MIT%E8%AE%B8%E5%8F%AF%EF%BC%89
• GitHub客户端：https://github.com/octokit/octokit.net%EF%BC%88MIT%E8%AE%B8%E5%8F%AF%EF%BC%89
• NuGet协议：https://github.com/NuGet/NuGet.Client%EF%BC%88Apache License Version 2.0）
• NuGet命令行：https://github.com/NuGet/NuGet.Client%EF%BC%88Apache License Version 2.0）
• 命令行解析：https://github.com/natemcmaster/CommandLineUtils%EF%BC%88Apache License Version 2.0）

致谢

Logo由https://github.com/area55git%E8%AE%BE%E8%AE%A1%EF%BC%8C%E9%87%87%E7%94%A8%E7%9F%A5%E8%AF%86%E5%85%B1%E4%BA%AB%E7%BD%B2%E5%90%8D4.0%E5%9B%BD%E9%99%85%E8%AE%B8%E5%8F%AF%E3%80%82