cli-completion 0.4.0

cli completion for bash, zsh, fish and powershell.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CLI JSON Schema",
  "description": "CLI JSON Schema for clap-rs YAML",
  "type": "object",
  "properties": {
    "name": {
      "description": "CLI name",
      "type": "string"
    },
    "author": {
      "type": "string",
      "description": "Sets a string of author(s) that will be displayed to the user when they request the help message"
    },
    "about": {
      "description": "Sets a string describing what the program does",
      "type": "string"
    },
    "version": {
      "description": "CLI version",
      "type": "string"
    },
    "after_help": {
      "type": "string",
      "description": "Adds additional help information to be displayed at the end of the auto-generated help"
    },
    "before_help": {
      "type": "string",
      "description": "Adds additional help information to be displayed prior to the auto-generated help"
    },
    "args": {
      "description": "arguments for CLI",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": {
          "$ref": "#/definitions/Arg"
        }
      }
    },
    "subcommands": {
      "description": "sub commands for CLI",
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": {
          "$ref": "#/definitions/Command"
        }
      }
    }
  },
  "required": [
    "name",
    "version",
    "about"
  ],
  "definitions": {
    "Arg": {
      "type": "object",
      "properties": {
        "about": {
          "type": "string",
          "description": "short help text of the argument"
        },
        "allow_hyphen_values": {
          "type": "boolean",
          "description": "Allows values which start with a leading hyphen (-)"
        },
        "default_value": {
          "type": "string",
          "description": "Specifies the value of the argument when not specified at runtime"
        },
        "hidden": {
          "type": "boolean",
          "description": "Hides an argument from help message output. NOTE: This does not hide the argument from usage."
        },
        "index": {
          "type": "number",
          "description": "Specifies the index of a positional argument starting at 1."
        },
        "long": {
          "type": "string",
          "description": "Sets the long version of the argument without the preceding --"
        },
        "multiple": {
          "type": "boolean",
          "description": "Specifies that the argument may have an unknown number of multiple values. Without any other settings, this argument may appear only once."
        },
        "possible_values": {
          "type": "array",
          "description": "possible values",
          "items": {
            "type": "string"
          }
        },
        "required": {
          "type": "boolean",
          "description": "Specifies that the argument is required by default"
        },
        "short": {
          "type": "string",
          "description": "Sets the short version of the argument without the preceding -"
        },
        "takes_value": {
          "type": "boolean",
          "description": "Specifies that the argument takes a value at run time"
        },
        "use_delimiter": {
          "type": "boolean",
          "description": "Specifies that an argument should allow grouping of multiple values via a delimiter, default is comma ,"
        },
        "value_hint": {
          "type": "string",
          "description": "Sets a hint about the type of the value for shell completions",
          "enum": [
            "AnyPath",
            "FilePath",
            "DirPath",
            "ExecutablePath",
            "CommandName",
            "CommandString",
            "CommandWithArguments",
            "Username",
            "Hostname",
            "Url",
            "EmailAddress"
          ]
        },
        "value_name": {
          "type": "string",
          "description": "Specifies the name for value of option or positional arguments inside of help documentation"
        }
      },
      "required": [
        "about"
      ]
    },
    "Command": {
      "type": "object",
      "properties": {
        "about": {
          "type": "string",
          "description": "Sets a string describing what the command does"
        },
        "after_help": {
          "type": "string",
          "description": "Adds additional help information to be displayed at the end of the auto-generated help"
        },
        "aliases": {
          "type": "array",
          "description": "adds a multiple aliases for command",
          "items": {
            "type": "string"
          }
        },
        "args": {
          "description": "Adds multiple arguments to the list of valid possibilities.",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/definitions/Arg"
            }
          }
        },
        "author": {
          "type": "string",
          "description": "Sets a string of author(s) that will be displayed to the user when they request the help message"
        },
        "version": {
          "type": "string",
          "description": "Sets a string of the version number to be displayed when displaying the short format version message"
        }
      },
      "required": [
        "about"
      ]
    }
  }
}