Home

Welcome to the clipper wiki!

Specification Schema

Root Object and Command

Field Name	Type	Additional info
name	string	Required & CamelCase - Used as command unique identifier
use	string	Required & Lower case
short	string	Optional
long	string	Optional
runnable	bool	Optional - default false - indicates new interface method to implement
flags	[Flag Object]	Optional
commands	[Command Object]	Optional

Flag object

Field Name	Type	Additional info
name	string	Required & Lower case
value	string	Required
type	string	Required - possible string values int64,int64Slice,bool,string
usage	string	Required usage of the flag
shorthand	string	Optional
persistent	bool	Optional - default false

Command object

Field Name	Type
name	string
usage	string
action	string
flags	[Flag Object]
subCommands	[Command Object]