zsh-cli-json-parser/schema.json at main · Integralist/zsh-cli-json-parser · GitHub

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
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CLI Structure",
  "description": "A schema for defining the commands, subcommands, and options of a command-line interface.",
  "type": "object",
  "properties": {
    "options": {
      "description": "Global options available for the CLI.",
      "type": "array",
      "items": { "$ref": "#/$defs/option" }
    },
    "commands": {
      "description": "Top-level commands for the CLI.",
      "type": "array",
      "items": { "$ref": "#/$defs/command" }
    }
  },
  "required": ["options", "commands"],
  "$defs": {
    "option": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the option (e.g., 'help')."
        },
        "description": {
          "type": "string",
          "description": "A brief description of what the option does."
        }
      },
      "required": ["name"]
    },
    "command": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the command (e.g., 'service')."
        },
        "description": {
          "type": "string",
          "description": "A brief description of what the command does."
        },
        "options": {
          "type": "array",
          "items": { "$ref": "#/$defs/option" }
        },
        "subcommands": {
          "type": "array",
          "items": { "$ref": "#/$defs/command" }
        }
      },
      "required": ["name"]
    }
  }
}