百度360必应搜狗淘宝本站头条
python判断字典是否为空crontab每周一执行aes和des区别安装指定版本npmadb pull
当前位置：网站首页 > IT知识 > 正文

PomeloCli :一整套的命令行开发、管理、维护方案

liuian 2025-04-29 02:06 7 浏览

我们已经有相当多的命令行工具实现或解析类库，PomeloCli 并不是替代版本，它基于 Nate McMaster 的杰出工作 CommandLineUtils、DotNetCorePlugins 实现了一整套的命令行开发、管理、维护方案，在此特别鸣谢 Nate。

为什么实现

作者述职于 devOps 部门，编写、维护 CLI 工具并将其部署到各个服务器节点上是很常规的需求，但是又常常面临一系列问题。

太多的工具太少的规范

命令行工具开发自由度过高，随之而来的是迥异的开发和使用体验：

  • 依赖和配置管理混乱；

  • 没有一致的参数、选项标准，缺失帮助命令；

  • 永远找不到版本对号的说明文档；

基于二进制拷贝分发难以为继

工具开发完了还需要部署到计算节点上，但是对运维人员极其不友好：

  • 永远不知道哪些机器有没有安装，安装了什么版本；

  • 需要进入工具目录配置运行参数；

快速开始

你可以直接开始，但是在此之前理解命令、参数和选项仍然有很大的帮助。相关内容可以参考 Introduction.

引用 PomeloCli 开发命令行应用

引用 PomeloCli 来快速创建自己的命令行应用

$ dotnet new console -n SampleApp
$ cd SampleApp
$ dotnet add package PomeloCli -v 1.3.0

在入口程序添加必要的处理逻辑，文件内容见于 docs/sample/3-sample-app/Program.cs。这里使用了依赖注入管理命令，相关参考见 .NET 依赖项注入。

using System;
using System.Threading.Tasks;
using Microsoft.Extensions.DependencyInjection;
using PomeloCli;

class Program
{
static async Task<int> Main(string[] args)
{
var services = new ServiceCollection()
.AddTransient<ICommand, EchoCommand>()
.AddTransient<ICommand, HeadCommand>()
.BuildServiceProvider();

var application = ApplicationFactory.ConstructFrom(services);
return await application.ExecuteAsync(args);
}
}

这里有两个命令：EchoCommand，是对 echo 命令的模拟，文件内容见于 docs/sample/3-sample-app/EchoCommand.cs

#able disable
using System;
using System.Threading;
using System.Threading.Tasks;
using McMaster.Extensions.CommandLineUtils;
using PomeloCli;

[Command("echo", Description = "display a line of text")]
class EchoCommand : Command
{
[Argument(0, "input")]
public String Input { get; set; }

[Option("-n|--newline", CommandOptionType.NoValue, Description = "do not output the trailing newline")]
public Boolean? Newline { get; set; }

protected override Task<int> OnExecuteAsync(CancellationToken cancellationToken)
{
if (Newline.HasValue)
{
 Console.WriteLine(Input);
}
else
{
 Console.Write(Input);
}
return Task.FromResult(0);
}
}

HeadCommand是对 head 命令的模拟，文件内容见于 docs/sample/3-sample-app/HeadCommand.cs。

#able disable
using System;
using System.ComponentModel.DataAnnotations;
using System.IO;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using McMaster.Extensions.CommandLineUtils;
using PomeloCli;

[Command("head", Description = "Print the first 10 lines of each FILE to standard output")]
class HeadCommand : Command
{
[Required]
[Argument(0)]
public String Path { get; set; }

[Option("-n|--line", CommandOptionType.SingleValue, Description = "print the first NUM lines instead of the first 10")]
public Int32 Line { get; set; } = 10;

protected override Task<int> OnExecuteAsync(CancellationToken cancellationToken)
{
if (!File.Exists(Path))
{
throw new FileNotFoundException($"file '{Path}' not found");
}

var lines = File.ReadLines(Path).Take(Line);
foreach (var line in lines)
{
 Console.WriteLine(line);
}
return Task.FromResult(0);
}
}

进入目录 SampleApp 后，既可以通过 dotnet run -- --help 查看包含的 echo 和 head 命令及使用说明。

$ dotnet run -- --help
Usage: SampleApp [command] [options]

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

Commands:
echo display a line of text
 head Print the first 10 lines of each FILE to standard output

Run 'SampleApp [command] -?|-h|--help' for more information about a command.

$ dotnet run -- echo --help
display a line of text

Usage: SampleApp echo [options] <input>

Arguments:
 input

Options:
 -n|--newline do not output the trailing newline
 -?|-h|--help Show help information.

也可以编译使用可执行的 SampleApp.exe 。

$ ./bin/Debug/net8.0/SampleApp.exe --help
Usage: SampleApp [command] [options]

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

Commands:
echo display a line of text
 head Print the first 10 lines of each FILE to standard output

Run 'SampleApp [command] -?|-h|--help' for more information about a command.

$ ./bin/Debug/net8.0/SampleApp.exe echo --help
display a line of text

Usage: SampleApp echo [options] <input>

Arguments:
 input

Options:
 -n|--newline do not output the trailing newline
 -?|-h|--help Show help information.

BRAVO 很简单对吧。

引用 PomeloCli 开发命令行插件

如果只是提供命令行应用的创建能力，作者大可不必发布这样一个项目，因为 McMaster.Extensions.CommandLineUtils 本身已经做得足够好了。如上文"为什么实现章节"所说，作者还希望解决命令行工具的分发维护问题。

为了实现这一目标，PomeloCli 继续基于 McMaster.NETCore.Plugins 实现了一套插件系统或者说架构：

  • 将命令行工具拆分成宿主和插件两部分功能；

  • 宿主负责安装、卸载、加载插件，作为命令行入口将参数转交给对应的插件；

  • 插件负责具体的业务功能的实现；

  • 宿主和插件均打包成标准的 nuget 制品；

插件加载示意

命令行参数传递示意

通过将宿主的维护交由 dotnet tool 处理、交插件的维护交由宿主处理，我们希望解决命令行工具的分发维护问题：

  • 开发人员

    • 开发插件

    • 使用 dotnet nuget push 发布插件

  • 运维/使用人员

    • 使用 dotnet tool安装、更新、卸载宿主

    • 使用 pomelo-cli install/uninstall 安装、更新、卸载插件

现在现在我们来开发一个插件应用。

开发命令行插件

引用 PomeloCli 来创建自己的命令行插件

$ dotnet new classlib -n SamplePlugin
$ cd SamplePlugin
$ dotnet add package PomeloCli -v 1.3.0

我们把上文提到的 EchoCommand 和 HeadCommand 复制到该项目，再添加依赖注入文件 ServiceCollectionExtensions.cs，文件内容见于 docs/sample/4-sample-plugin/ServiceCollectionExtensions.cs

using System;
using System.Threading.Tasks;
using Microsoft.Extensions.DependencyInjection;
using PomeloCli;

public static class ServiceCollectionExtensions
{
/// <summary>
/// pomelo-cli load plugin by this method, see
/// <see cref="PomeloCli.Plugins.Runtime.PluginResolver.Loading()" />
/// </summary>
/// <param name="services"></param>
/// <returns></returns>
public static IServiceCollection AddCommands(this IServiceCollection services)
{
return services
.AddTransient<ICommand, EchoCommand>()
.AddTransient<ICommand, HeadCommand>();
}
}

为了能够使得插件运行起来，我们还需要在打包时将依赖添加到 nupkg 文件中。为此需要修改 csproj 添加打包配置，参考 docs/sample/4-sample-plugin/SamplePlugin.csproj，相关原理见出处 How to include package reference files in your nuget

搭建私有 nuget 服务

为了托管我们的工具与插件，我们这里使用 BaGet 搭建轻量的 nuget 服务，docker-compose.yaml 已经提供见 baget。docker 等工具使用请自行查阅。

version: "3.3"
services:
baget:
image: loicsharma/baget
container_name: baget
ports:
 - "8000:80"
volumes:
 - $PWD/data:/var/baget

我们使用 docker-compose up -d 将其运行起来，baget 将在地址 http://localhost:8000/ 上提供服务。

发布命令行插件

现我们在有了插件和 nuget 服务，可以发布插件了。

$ cd SamplePlugin
$ dotnet pack -o nupkgs -c Debug
$ dotnet nuget push -s http://localhost:8000/v3/index.json nupkgs/SamplePlugin.1.0.0.nupkg

使用 PomeloCli 集成已发布插件

pomelo-cli 是一个 dotnet tool 应用，可以看作命令行宿主，它包含了一组 plugin 命令用来管理我们的命令行插件。

安装命令行宿主

我们使用标准的 dotnet tool CLI 命令安装 PomeloCli，相关参考见 How to manage .NET tools

$ dotnet tool install PomeloCli.Host --version 1.3.0 -g
$ pomelo-cli --help
Usage: PomeloCli.Host [command] [options]

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

Commands:
 config
 plugin
 version

Run 'PomeloCli.Host [command] -?|-h|--help' for more information about a command.

可以看到 pomelo-cli 内置了部分命令。

集成命令行插件

pomelo-cli 内置了一组插件，包含了其他插件的管理命令

$ pomelo-cli plugin --help
Usage: PomeloCli.Host plugin [command] [options]

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

Commands:
 install
 list
 uninstall

Run 'plugin [command] -?|-h|--help' for more information about a command.

我们用 plugin install 命令安装刚刚发布的插件 SamplePlugin

$ pomelo-cli plugin install SamplePlugin -v 1.0.0 -s http://localhost:8000/v3/index.json
$ pomelo-cli --help
Usage: PomeloCli.Host [command] [options]

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

Commands:
 config
echo display a line of text
 head Print the first 10 lines of each FILE to standard output
 plugin
 version

Run 'PomeloCli.Host [command] -?|-h|--help' for more information about a command.

$ pomelo-cli echo --help
display a line of text

Usage: PomeloCli.Host echo [options] <input>

Arguments:
 input

Options:
 -n|--newline do not output the trailing newline
 -?|-h|--help Show help information.

可以看到 SamplePlugin 包含的 echo 和 head 命令已经被显示在子命令列表中。

卸载命令行插件

pomelo-cli 当然也可以卸载其他插件

$ pomelo-cli plugin uninstall SamplePlugin

卸载命令行宿主

我们使用标准的 dotnet tool CLI 命令卸载 PomeloCli

$ dotnet tool uninstall PomeloCli.Host -g

其他：异常 NU1102 的处理

当安装插件失败且错误码是NU1102 时，表示未找到对应版本，可以执行命令 $ dotnet nuget locals http-cache --clear 以清理 HTTP 缓存。

info : Restoring packages for C:\Users\leon\.PomeloCli.Host\Plugin.csproj...
info : GET http://localhost:8000/v3/package/sampleplugin/index.json
info : OK http://localhost:8000/v3/package/sampleplugin/index.json 2ms
error: NU1102: Unable to find package SamplePlugin with version (>= 1.1.0)
error: - Found 7 version(s) in http://localhost:8000/v3/index.json [ Nearest version: 1.0.0 ]
error: Package 'SamplePlugin' is incompatible with 'user specified' frameworks in project 'C:\Users\leon\.PomeloCli.Host\Plugin.csproj'.

其他事项

已知问题

  • refit 支持存在问题

路线图

  • 业务插件配置

项目仍然在开发中，欢迎与我交流想法：https://github.com/leoninew/PomeloCli/


相关推荐

深入解析 MySQL 8.0 JSON 相关函数:解锁数据存储的无限可能

引言在现代应用程序中，数据的存储和处理变得愈发复杂多样。MySQL8.0引入了丰富的JSON相关函数，为我们提供了更灵活的数据存储和检索方式。本文将深入探讨MySQL8.0中的JSON...

MySQL的Json类型个人用法详解（mysql json类型对应java什么类型）

前言虽然MySQL很早就添加了Json类型，但是在业务开发过程中还是很少设计带这种类型的表。少不代表没有，当真正要对Json类型进行特定查询，修改，插入和优化等操作时，却感觉一下子想不起那些函数怎么使...

MySQL的json查询之json_array（mysql json_search）

json_array顾名思义就是创建一个数组，实际的用法，我目前没有想到很好的使用场景。使用官方的例子说明一下吧。例一selectjson_array(1,2,3,4);json_array虽然单独...

头条创作挑战赛#一、LSTM 原理 长短期记忆网络

#头条创作挑战赛#一、LSTM原理长短期记忆网络（LongShort-TermMemory，LSTM）是一种特殊类型的循环神经网络（RNN），旨在解决传统RNN在处理长序列数据时面临的梯度...

TensorBoard最全使用教程:看这篇就够了

机器学习通常涉及在训练期间可视化和度量模型的性能。有许多工具可用于此任务。在本文中，我们将重点介绍TensorFlow的开源工具套件，称为TensorBoard，虽然他是TensorFlow...

图神经网络版本的Kolmogorov Arnold(KAN)代码实现和效果对比

本文约4600字，建议阅读10分钟本文介绍了图神经网络版本的对比。KolmogorovArnoldNetworks(KAN)最近作为MLP的替代而流行起来，KANs使用Kolmogorov-Ar...

kornia，一个实用的 Python 库!（python kkb_tools）

大家好，今天为大家分享一个实用的Python库-kornia。Github地址：https://github.com/kornia/kornia/Kornia是一个基于PyTorch的开源计算...

图像分割掩码标注转YOLO多边形标注

Ultralytics团队付出了巨大的努力，使创建自定义YOLO模型变得非常容易。但是，处理大型数据集仍然很痛苦。训练yolo分割模型需要数据集具有其特定格式，这可能与你从大型数据集中获得的...

[python] 向量检索库Faiss使用指北

Faiss是一个由facebook开发以用于高效相似性搜索和密集向量聚类的库。它能够在任意大小的向量集中进行搜索。它还包含用于评估和参数调整的支持代码。Faiss是用C++编写的，带有Python的完...

如何把未量化的 70B 大模型加载到笔记本电脑上运行?

并行运行70B大模型我们已经看到，量化已经成为在低端GPU（比如Colab、Kaggle等）上加载大型语言模型（LLMs）的最常见方法了，但这会降低准确性并增加幻觉现象。那如果你和你的朋友们...

ncnn+PPYOLOv2首次结合!全网最详细代码解读来了

编辑：好困LRS【新智元导读】今天给大家安利一个宝藏仓库miemiedetection，该仓库集合了PPYOLO、PPYOLOv2、PPYOLOE三个算法pytorch实现三合一，其中的PPYOL...

人工智能——图像识别（人工智能图像识别流程）

概述图像识别（ImageRecognition）是计算机视觉的核心任务之一，旨在通过算法让计算机理解图像内容，包括分类（识别物体类别）、检测（定位并识别多个物体）、分割（像素级识别）等，常见的应用场...

PyTorch 深度学习实战(15):Twin Delayed DDPG (TD3) 算法

在上一篇文章中，我们介绍了DeepDeterministicPolicyGradient(DDPG)算法，并使用它解决了Pendulum问题。本文将深入探讨TwinDelayed...

大模型中常用的注意力机制GQA详解以及Pytorch代码实现

分组查询注意力(GroupedQueryAttention)是一种在大型语言模型中的多查询注意力(MQA)和多头注意力(MHA)之间进行插值的方法，它的目标是在保持MQA速度的同时...

pytorch如何快速创建具有特殊意思的tensor张量?

专栏推荐正文我们通过值可以看到torch.empty并没有进行初始化创建tensor并进行随机初始化操作，常用rand/rand_like,randint正态分布（0，1）指定正态分布的均值还有方差i...

一周热门
最近发表
标签列表