无法创建具有特定提要的CLI-具有Picocli的CLI

Question

我想在picocli中创建具有以下概要的CLI

Command (--option1=<value1> [--req11=<v11> --req12=<v12> --req13=<v13>] | --option2=<value2> [--req21=<v21> --req22=<v22>] | --option3=<value3> | --option4=<value4>) 

我试图创建嵌套组，但是没有成功。有什么帮助吗？

提前感谢

Answer 1

使用嵌套组，我能够创建此提要：

Usage: mycmd ((--option1=<value1> [--req11=<v11> --req12=<v12> --req13=<v13>])
             | (--option2=<value2> [--req21=<v21> --req22=<v22>]) |
             (--option3=<value3>) | (--option4=<value4>))

这在功能上与您的简介相同，但有一些多余的花括号。

这里是代码：

import picocli.CommandLine;
import picocli.CommandLine.ArgGroup;
import picocli.CommandLine.Command;
import picocli.CommandLine.Option;

@Command(name = "mycmd")
public class SynopsisDemo implements Runnable {

    static class Group1 {
        @Option(names = "--option1", required = true)
        String value1;

        @ArgGroup(exclusive = false, multiplicity = "0..1")
        Group1Inner inner1;
    }

    static class Group1Inner {
        @Option(names = "--req11", required = true) String v11;
        @Option(names = "--req12", required = true) String v12;
        @Option(names = "--req13", required = true) String v13;
    }

    static class Group2 {
        @Option(names = "--option2", required = true)
        String value2;

        @ArgGroup(exclusive = false, multiplicity = "0..1")
        Group2Inner inner2;
    }

    static class Group2Inner {
        @Option(names = "--req21", required = true) String v21;
        @Option(names = "--req22", required = true) String v22;
    }

    static class Group3 {
        @Option(names = "--option3", required = true)
        String value3;
    }

    static class Group4 {
        @Option(names = "--option4", required = true)
        String value4;
    }

    static class AllGroups {
        @ArgGroup(exclusive = false, multiplicity = "1") Group1 group1;
        @ArgGroup(exclusive = false, multiplicity = "1") Group2 group2;
        @ArgGroup(exclusive = false, multiplicity = "1") Group3 group3;
        @ArgGroup(exclusive = false, multiplicity = "1") Group4 group4;
    }

    @ArgGroup(exclusive = true, multiplicity = "1")
    AllGroups allGroups;

    @Override
    public void run() {
        // business logic here
    }

    // Goal:
    // Command (--option1=<value1> [--req11=<v11> --req12=<v12> --req13=<v13>]
    //         | --option2=<value2> [--req21=<v21> --req22=<v22>]
    //         | --option3=<value3> | --option4=<value4>)
    public static void main(String[] args) {
        //new CommandLine(new SynopsisDemo()).execute(args);
        new CommandLine(new SynopsisDemo()).usage(System.out);
    }
}

[我试图通过将--option3定义移出Group3 / 4并移到--option4中来消除@Option和AllGroups周围的花括号，但是导致这些选项移到了提要的开头：] >

Usage: mycmd (--option3=<value3> | --option4=<value4> | (--option1=<value1>
             [--req11=<v11> --req12=<v12> --req13=<v13>]) | (--option2=<value2>
             [--req21=<v21> --req22=<v22>]))
然后我尝试通过指定order将这些选项移到最后，如下所示：

static class AllGroups {
    @ArgGroup(exclusive = false, multiplicity = "1") Group1 group1;
    @ArgGroup(exclusive = false, multiplicity = "1") Group2 group2;
    @Option(names = "--option3", required = true, order = 3) String value3;
    @Option(names = "--option4", required = true, order = 4) String value4;
}
但是看起来order当前仅可用于选项列表中的control where options和arg-groups appear，它不会影响摘要。为此，我在picocli问题跟踪器中打开了this issue。非常欢迎您输入这张票。

解决方法

同时，您可以通过指定custom synopsis来获得所需的exact

简介，如下所示：

@Command(name = "mycmd",
        customSynopsis = {
                "mycmd (--option1=<value1> [--req11=<v11> --req12=<v12> --req13=<v13>]",
                "       | --option2=<value2> [--req21=<v21> --req22=<v22>]",
                "       | --option3=<value3> | --option4=<value4>)"
        })
public class SynopsisDemo implements Runnable { // ...
这将产生以下概要（我相信这符合您的要求）：

Usage: mycmd (--option1=<value1> [--req11=<v11> --req12=<v12> --req13=<v13>]
       | --option2=<value2> [--req21=<v21> --req22=<v22>]
       | --option3=<value3> | --option4=<value4>)