schema.json

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "OpenCLI.json",
    "type": "object",
    "properties": {
        "opencli": {
            "type": "string",
            "description": "The OpenCLI version number"
        },
        "info": {
            "$ref": "#/$defs/CliInfo",
            "description": "Information about the CLI"
        },
        "conventions": {
            "$ref": "#/$defs/Conventions",
            "description": "The conventions used by the CLI"
        },
        "arguments": {
            "type": "array",
            "items": {
                "$ref": "#/$defs/Argument"
            },
            "description": "Root command arguments"
        },
        "options": {
            "type": "array",
            "items": {
                "$ref": "#/$defs/Option"
            },
            "description": "Root command options"
        },
        "commands": {
            "type": "array",
            "items": {
                "$ref": "#/$defs/Command"
            },
            "description": "Root command sub commands"
        },
        "exitCodes": {
            "type": "array",
            "items": {
                "$ref": "#/$defs/ExitCode"
            },
            "description": "Root command exit codes"
        },
        "examples": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "Examples of how to use the CLI"
        },
        "interactive": {
            "type": "boolean",
            "description": "Indicates whether or not the command requires interactive input"
        },
        "metadata": {
            "type": "array",
            "items": {
                "$ref": "#/$defs/Metadata"
            },
            "description": "Custom metadata"
        }
    },
    "required": [
        "opencli",
        "info"
    ],
    "description": "The OpenCLI description",
    "$defs": {
        "CliInfo": {
            "type": "object",
            "properties": {
                "title": {
                    "type": "string",
                    "description": "The application title"
                },
                "summary": {
                    "type": "string",
                    "description": "A short summary of the application"
                },
                "description": {
                    "type": "string",
                    "description": "A description of the application"
                },
                "contact": {
                    "$ref": "#/$defs/Contact",
                    "description": "The contact information"
                },
                "license": {
                    "$ref": "#/$defs/License",
                    "description": "The application license"
                },
                "version": {
                    "type": "string",
                    "description": "The application version"
                }
            },
            "required": [
                "title",
                "version"
            ]
        },
        "Conventions": {
            "type": "object",
            "properties": {
                "groupOptions": {
                    "type": "boolean",
                    "default": true,
                    "description": "Whether or not grouping of short options are allowed"
                },
                "optionSeparator": {
                    "type": "string",
                    "default": " ",
                    "description": "The option argument separator"
                }
            }
        },
        "Argument": {
            "type": "object",
            "properties": {
                "name": {
                    "type": "string",
                    "description": "The argument name"
                },
                "required": {
                    "type": "boolean",
                    "description": "Whether or not the argument is required"
                },
                "arity": {
                    "$ref": "#/$defs/Arity",
                    "default": {
                        "minimum": 1,
                        "maximum": 1
                    },
                    "description": "The argument arity. Arity defines the minimum and maximum number of argument values"
                },
                "acceptedValues": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "description": "A list of accepted values"
                },
                "group": {
                    "type": "string",
                    "description": "The argument group"
                },
                "description": {
                    "type": "string",
                    "description": "The argument description"
                },
                "hidden": {
                    "type": "boolean",
                    "default": false,
                    "description": "Whether or not the argument is hidden"
                },
                "metadata": {
                    "type": "array",
                    "items": {
                        "$ref": "#/$defs/Metadata"
                    },
                    "description": "Custom metadata"
                }
            },
            "required": [
                "name"
            ]
        },
        "Option": {
            "type": "object",
            "properties": {
                "name": {
                    "type": "string",
                    "description": "The option name"
                },
                "required": {
                    "type": "boolean",
                    "description": "Whether or not the option is required"
                },
                "aliases": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "uniqueItems": true,
                    "description": "The option's aliases"
                },
                "arguments": {
                    "type": "array",
                    "items": {
                        "$ref": "#/$defs/Argument"
                    },
                    "description": "The option's arguments"
                },
                "group": {
                    "type": "string",
                    "description": "The option group"
                },
                "description": {
                    "type": "string",
                    "description": "The option description"
                },
                "recursive": {
                    "type": "boolean",
                    "default": false,
                    "description": "Specifies whether the option is accessible from the immediate parent command and, recursively, from its subcommands"
                },
                "hidden": {
                    "type": "boolean",
                    "default": false,
                    "description": "Whether or not the option is hidden"
                },
                "metadata": {
                    "type": "array",
                    "items": {
                        "$ref": "#/$defs/Metadata"
                    },
                    "description": "Custom metadata"
                }
            },
            "required": [
                "name"
            ]
        },
        "Command": {
            "type": "object",
            "properties": {
                "name": {
                    "type": "string",
                    "description": "The command name"
                },
                "aliases": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "uniqueItems": true,
                    "description": "The command aliases"
                },
                "options": {
                    "type": "array",
                    "items": {
                        "$ref": "#/$defs/Option"
                    },
                    "description": "The command options"
                },
                "arguments": {
                    "type": "array",
                    "items": {
                        "$ref": "#/$defs/Argument"
                    },
                    "description": "The command arguments"
                },
                "commands": {
                    "type": "array",
                    "items": {
                        "$ref": "#/$defs/Command"
                    },
                    "description": "The command's sub commands"
                },
                "exitCodes": {
                    "type": "array",
                    "items": {
                        "$ref": "#/$defs/ExitCode"
                    },
                    "description": "The command's exit codes"
                },
                "description": {
                    "type": "string",
                    "description": "The command description"
                },
                "hidden": {
                    "type": "boolean",
                    "default": false,
                    "description": "Whether or not the command is hidden"
                },
                "examples": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "description": "Examples of how to use the command"
                },
                "interactive": {
                    "type": "boolean",
                    "description": "Indicate whether or not the command requires interactive input"
                },
                "metadata": {
                    "type": "array",
                    "items": {
                        "$ref": "#/$defs/Metadata"
                    },
                    "description": "Custom metadata"
                }
            },
            "required": [
                "name"
            ]
        },
        "ExitCode": {
            "type": "object",
            "properties": {
                "code": {
                    "type": "integer",
                    "description": "The exit code"
                },
                "description": {
                    "type": "string",
                    "description": "The exit code description"
                }
            },
            "required": [
                "code"
            ]
        },
        "Metadata": {
            "type": "object",
            "properties": {
                "name": {
                    "type": "string"
                },
                "value": {}
            },
            "required": [
                "name"
            ]
        },
        "Contact": {
            "type": "object",
            "properties": {
                "name": {
                    "type": "string",
                    "description": "The identifying name of the contact person/organization"
                },
                "url": {
                    "type": "string",
                    "format": "uri",
                    "description": "The URI for the contact information. This MUST be in the form of a URI."
                },
                "email": {
                    "$ref": "#/$defs/email",
                    "description": "The email address of the contact person/organization. This MUST be in the form of an email address."
                }
            },
            "description": "Contact information"
        },
        "License": {
            "type": "object",
            "properties": {
                "name": {
                    "type": "string",
                    "description": "The license name"
                },
                "identifier": {
                    "type": "string",
                    "description": "The SPDX license identifier"
                },
                "url": {
                    "type": "string",
                    "description": "The URI for the license. This MUST be in the form of a URI"
                }
            }
        },
        "Arity": {
            "type": "object",
            "properties": {
                "minimum": {
                    "type": "integer",
                    "minimum": 0,
                    "description": "The minimum number of values allowed"
                },
                "maximum": {
                    "type": "integer",
                    "minimum": 0,
                    "description": "The maximum number of values allowed"
                }
            },
            "description": "Arity defines the minimum and maximum number of argument values"
        },
        "email": {
            "type": "string",
            "pattern": ".+\\@.+\\..+"
        }
    }
}