diclipy/dependencies/clap/examples/nested.json

{
    "doc": {
        "help": "This is example UI with nested commands. It can be used to learn how UIs with nested commands are built in CLAP and how to interact with them in programs' code and on the commandline. It takes no operands. This description is taken from 'doc' field.",
        "usage": [
            "--help",
            "--version",
            "[--verbose | --quiet] <mode> [opts...]"
        ],
        "examples": [
            {
                "line": "--verbose foo --alpha",
                "desc": "do stuff"
            },
            {
                "line": "foo --quiet bary -gd",
                "desc": "do moar stuff"
            },
            {
                "line": "help --verbose | help --help",
                "desc": "display detailed help message"
            },
            {
                "line": "help --verbose -- [operand...]  |  help --help -- [operand...]",
                "desc": "display detailed help mesasge about chosen element"
            }
        ]
    },
    "options": {
        "global": [
            {
                "short": "h",
                "long": "help",
                "help": "display help message"
            },
            {
                "short": "v",
                "long": "verbose",
                "conflicts": ["--quiet"],
                "help": "display verbose output"
            },
            {
                "short": "q",
                "long": "quiet",
                "conflicts": ["--verbose"],
                "help": "be silent"
            }
        ],
        "local": [
            {
                "long": "version",
                "conflicts": ["--help"],
                "help": "display CLAP version"
            }
        ]
    },
    "commands": {
        "foo": {
            "doc": {
                "help": "This is child mode with name 'foo'."
            },
            "options": {
                "local": [
                    {
                        "short": "a",
                        "long": "alpha",
                        "help": "first letter of Greek alphabet"
                    },
                    {
                        "short": "b",
                        "long": "beta",
                        "arguments": ["int"],
                        "help": "second letter of Greek alphabet"
                    }
                ]
            },
            "commands": {
                "bary": {
                    "doc": {"help": "This is child-child mode with name 'bary'. It has some pretty long description. Not that this description (or summary? or whatever...) will tell you anything interesting, it's here only to stress the help screen builder with a description containing many words so the line-breaking can be tested. And some more words, just to make sure it is long."},
                    "options": {
                        "local": [
                            {
                                "short": "g",
                                "long": "gamma",
                                "help": "third letter of Greek alphabet"
                            },
                            {
                                "short": "d",
                                "long": "delta",
                                "arguments": ["int"],
                                "help": "fourth letter of Greek alphabet"
                            }
                        ]
                    },
                    "commands": {
                        "baz": {
                            "doc": {"help": "This is child-child-child mode with name 'baz'."},
                            "options": {
                                "local": [
                                    {
                                        "short": "e",
                                        "long": "epsilon",
                                        "help": "fifth letter of Greek alphabet"
                                    },
                                    {
                                        "short": "z",
                                        "long": "zeta",
                                        "arguments": ["int"],
                                        "help": "sixth letter of Greek alphabet"
                                    }
                                ]
                            }
                        }
                    }
                },
                "bax": {
                    "doc": {"help": "This is child-child mode with name 'bax'."},
                    "options": {
                        "local": [
                            {
                                "long": "eta",
                                "help": "seventh letter of Greek alphabet"
                            },
                            {
                                "long": "theta",
                                "help": "eighth letter of Greek alphabet"
                            }
                        ]
                    }
                }
            }
        }
    },
    "operands": {"no": [0, 0]}
}