Description Document Object
Field Name
Type
Default Value
Description
opencli
string
REQUIRED The OpenCLI version number
info
CliInfo Object
REQUIRED Information about the CLI
conventions
Conventions Object
The conventions used by the CLI
arguments
[Argument Object ]
Root command arguments
options
[Option Object ]
Root command options
commands
[Command Object ]
Root command sub commands
exitCodes
[ExitCode Object ]
Root command exit codes
examples
[string]
Examples of how to use the CLI
interactive
bool
false
Indicates whether or not the command requires interactive input
metadata
[Metadata Object ]
Custom metadata
CliInfo Object
Field Name
Type
Default Value
Description
title
string
REQUIRED The application title
summary
string
A short summary of the application
description
string
A description of the application
contact
Contact Object
The contact information
license
License Object
The application license
version
string
REQUIRED The application version
Conventions Object
Field Name
Type
Default Value
Description
groupOptions
bool
true
Whether or not grouping of short options are allowed
optionArgumentSeparator
string
U+0020 (space)
The option argument separator
Contact Object
Field Name
Format
Default Value
Description
name
string
The identifying name of the contact person/organization
url
string
The URI for the contact information. This MUST be in the form of a URI
email
string
The email address of the contact person/organization. This MUST be in the form of an email address
License Object
Field Name
Type
Default Value
Description
name
string
The license name
identifier
string
The SPDX license identifier
Command Object
Field Name
Type
Default Value
Description
name
string
REQUIRED The command name
aliases
[string]
The command aliases
options
[Option Object ]
The command's options
arguments
[Argument Object ]
The command's arguments
commands
[Command Object ]
The command's sub commands
exitCodes
[ExitCode Object ]
The command's exit codes
description
string
The command description
hidden
bool
false
Whether or not the command is hidden
examples
[string]
Examples of how to use the command
interactive
bool
false
Indicates whether or not the command requires interactive input
metadata
[Metadata Object ]
Custom metadata
Argument Object
Field Name
Type
Default Value
Description
name
string
REQUIRED The argument name
required
bool
false
Whether or not the argument is required
arity
Arity Object
The argument arity. Arity defines the minimum and maximum number of argument values
acceptedValues
[string]
A list of accepted values
group
string
The argument group
decription
string
The argument description
hidden
bool
false
Whether or not the argument is hidden
metadata
[Metadata Object ]
Custom metadata
Option Object
Field Name
Type
Default Value
Description
name
string
REQUIRED The option name
required
bool
false
Whether or not the option is required
aliases
[string]
The option's aliases
arguments
[Argument ]
The option's arguments
group
string
The option group
description
string
The option description
recursive
bool
false
Specifies whether the option is accessible from the immediate parent command and, recursively, from its subcommands
hidden
bool
false
Whether or not the option is hidden
metadata
[Metadata Object ]
Custom metadata
Arity Object
Field Name
Type
Default Value
Description
minimum
int
1
The minimum number of values allowed
maximum
int
1
The maximum number of values allowed
ExitCode Object
Field Name
Type
Default Value
Description
code
int
REQUIRED The exit code
description
string
The exit code description
Metadata Object
Field Name
Type
Default Value
Description
name
string
REQUIRED The metadata name
value
object
The metadata value
Reactions are currently unavailable
You can’t perform that action at this time.