更好的命令行界面

Question

我开发了一个缓存多个包的应用程序。 此应用程序的CLI界面如下所示

submit -z pkg1.zip -c pkgChecksum1 -t pkgType1 -s pkgSize1 -z pkg2.zip -c pkgChecksum2 -t pkgType2 -s pkgSize2 

所以这提交了2个包pkg1.zip和pkg2.zip，它们分别有校验和pkgChecksum1和pkgChecksum2，包类型为pkgType1和pkgType2，大小分别为pkgSize1和pkgSize2。

我们还为应用程序提供了基于XML的输入，如下所示

submit --script an.xml

其中an.xml是

<?xml version="1.0" encoding="ISO-8859-1"?>
<packages>
<package name="pkg1.zip" checksum="pkgChecksum1" type="pkgType1" size="pkgSize1" />
<package name="pkg2.zip" checksum="pkgChecksum2" type="pkgType2" size="pkgSize2" />
</packages>

这是第一个CLI方法的功能等价物。

我们计划让这个用户更友好，有什么想法可以改进吗？

Answer 1

是否需要所有选项？ 或者是否有类型和大小以及校验和的默认值？ 如果没有默认值，您可以删除标记，只需要四个一组的参数。

submit pkg1.zip pkg1Cksum pkg1type pkg1sz pkg2.zip pkg2Cksum pkg2type pkg2sz 

此情况下的另一个选项是使用标记，但会提示用户输入缺失值。

如果存在默认值（可以自动计算校验和和大小吗？），请允许选择性覆盖：

submit pkg1.zip -t pkg1type pkg2.zip -t pkg2type -s pkg2szOverride

另一个可能有用的选项是-a existingCache ，它附加到现有文件（或者如果不存在则创建它）。 这将让用户将其分解为几个可以处理的命令行

   submit -a mycache pkg1.zip -t pkg1type -s pkg1sz
   submit -a mycache pkg2.zip -t pkg2type -s pkg2sz

还有一个选项，基于评论：

  submit -x pkg1.zip:2034 0x232D -y pkg2.zip pkg3.zip:123

其中-x，-y等是不同支持的“类型”的标志。 所以这一行提交pkg1，大小为2034，类型为X，校验和; y型的pkg2，未指定大小或校验和; 和pkg3的大小为123，没有指定类型或校验和。

Answer 2

您应该为CLI中的各种参数提供长选项和短选项。 例如

submit --package pkg1.zip --checksum pkgChecksum1 --type pkgType1 --size pkgSize1 --package  pkg2.zip -checksum pkgChecksum2 --type pkgType2 --size pkgSize2

Answer 3

很难说你应该做什么。 这取决于谁是您的应用程序的目标受众。 两种可能的选择：

1. GUI界面，适用于不知道/害怕使用CLI的用户
2. 交互式CLI，类似于：

 Package name: > pkg1.zip Checksum: > pkgChecksum1 Type: pkgType1 

Answer 4

我遇到的另一个选择：

submit pkg1.zip:type:2034:0x232D     pkg2.zip:type2:2034:0x232D

我认为问题在于提交可以为每个参数管理多个选项，因此一次添加它们可以使界面更简单。 记住每一个的类型，大小和chksum应该不难。 毕竟，似乎所有参数都是强制性的。 这样，就不可能将一个包的选项与另一个包的选项混为一谈。