@hkvstore/taco-cli/cli/commands.json

taco-cli is a command-line interface for rapid Apache Cordova development (forked from Microsoft taco-cli)

{
    "commands":
    {
        "create":
        {
            "synopsis": "<synopsis><PATH> [ID [NAME [CONFIG]]] [--OPTIONS]</synopsis>",
            "categoryTitle": "[ProjectCommandsTitle]",
            "modulePath": "./create",
            "description": "<helptitle>[CommandCreateDescription]</helptitle>",
            "args": [
            {
                "name": "PATH", "description": "[CommandCreateArgsPath]"
            }
            ,
            {
                "name": "ID", "description": "[CommandCreateArgsId]"
            }
            ,
            {
                "name": "NAME", "description": "[CommandCreateArgsName]"
            }
            ,
            {
                "name": "CONFIG", "description": "[CommandCreateArgsConfig]"
            }
            ],
            "options": [
            {
                "name": "--kit [NAME]", "description": "[CommandCreateOptionsKit]"
            }
            ,
            {
                "name": "--template <NAME|GIT-URL>", "description": "[CommandCreateOptionsTemplate]"
            }
            ,
            {
                "name": "--cordova <VERSION>", "description": "[CommandCreateOptionsCordova]"
            }
            ,
            {
                "name": "--copy-from|src <PATH>", "description": "[CommandCreateOptionsCopy]"
            }
            ,
            {
                "name": "--link-to <PATH>", "description": "[CommandCreateOptionsLinkto]"
            }
            ]
        }
        ,
        "templates":
        {
            "synopsis": "<synopsis></synopsis>",
            "categoryTitle": "[ProjectCommandsTitle]",
            "modulePath": "./templates",
            "description": "<helptitle>[CommandTemplatesDescription]</helptitle>"
        }
        ,
        "kit":
        {
            "synopsis": "<synopsis>[COMMAND] [--OPTIONS]</synopsis>",
            "categoryTitle": "[ProjectCommandsTitle]",
            "modulePath": "./kit",
            "description": "<helptitle>[CommandKitDescription]</helptitle>",
            "args": [
            {
                "name": "list",
                "description": "[CommandKitListSubcommandDescription]",
                "options": [
                {
                    "name": "--json <PATH>", "description": "[CommandKitJsonOptionDescription]"
                }
                ,
                {
                    "name": "--kit <KIT-ID>", "description": "[CommandKitOptionKitDescription]"
                }
                ]
            }
            ,
            {
                "name": "select",
                "description": "[CommandKitSelectSubcommandDescription]",
                "options": [
                {
                    "name": "--kit <KIT-ID>", "description": "[CommandKitSelectOptionKitDescription]"
                }
                ,
                {
                    "name": "--cordova <VERSION>", "description": "[CommandKitSelectOptionCordovaDescription]"
                }
                ]
            }
            ],
            "examples": [
            { 
                "example": "taco kit list --kit tacokit@2.0.0", 
                "description": "[TacoKitListExample]" 
            },
            { 
                "example": "taco kit select --kit tacokit@2.0.0", 
                "description": "[TacoKitSelectExample1]" 
            },
            { 
                "example": "taco kit select --cordova 5.2.0", 
                "description": "[TacoKitSelectExample2]" 
            }
            ],
            "notes": [
                "[TacoKitNotes]"
            ]
        }
        ,
        "platform":
        {
            "synopsis": "<synopsis>[COMMAND] [--OPTIONS]</synopsis>",
            "categoryTitle": "[ProjectCommandsTitle]",
            "modulePath": "./platform",
            "description": "<helptitle>[CommandPlatformDescription]</helptitle>",
            "args": [
            {
                "name": "add <PLAT-SPEC>",
                "description": "[CommandPlatformAddSubcommandDescription]",
                "options": [
                {
                    "name": "--usegit", "description": "[CommandPlatformUsegitDescription]"
                }
                ,
                {
                    "name": "--save", "description": "[CommandPlatformSaveAddDescription]"
                }
                ,
                {
                    "name": "--link", "description": "[CommandPlatformLinkDescription]"
                }
                ]
            }
            ,
            {
                "name": "remove <PLATFORM>",
                "description": "[CommandPlatformRemoveSubcommandDescription]",
                "options": [
                {
                    "name": "--save", "description": "[CommandPlatformSaveRemoveDescription]"
                }
                ]
            }
            ,
            {
                "name": "list", "description": "[CommandPlatformListSubcommandDescription]"
            }
            ,
            {
                "name": "update <PLAT-SPEC>",
                "description": "[CommandPlatformUpdateSubcommandDescription]",
                "options": [
                {
                    "name": "--usegit", "description": "[CommandPlatformUsegitDescription]"
                }
                ,
                {
                    "name": "--save", "description": "[CommandPlatformSaveUpdateDescription]"
                }
                ]
            }
            ,
            {
                "name": "check", "description": "[CommandPlatformCheckSubcommandDescription]"
            }
            ],
            "syntax": [
            {
                "name": "plat-spec", "description": "[CommandPlatformOptPlatSpecDescription]"
            }
            ,
            {
                "name": "platform-ver", "description": "[CommandPlatformOptPlatVersionDescription]"
            }
            ,
            {
                "name": "platform", "description": "[CommandPlatformOptPlatformDescription]"
            }
            ,
            {
                "name": "path", "description": "[CommandPlatformOptPathDescription]"
            }
            ,
            {
                "name": "git-url", "description": "[CommandPlatformOptGitUrlDescription]"
            }
            ,
            {
                "name": "url", "description": "[CommandPlatformOptUrlDescription]"
            }
            ,
            {
                "name": "version", "description": "[CommandPlatformOptVersionDescription]"
            }
            ,
            {
                "name": "branch", "description": "[CommandPlatformOptBranchDescription]"
            }
            ],
            "aliases": {
                "rm": "remove",
                "ls": "list"
            }
        }
        ,
        "plugin":
        {
            "synopsis": "<synopsis>[COMMAND] [--OPTIONS]</synopsis>",
            "categoryTitle": "[ProjectCommandsTitle]",
            "modulePath": "./plugin",
            "description": "<helptitle>[CommandPluginDescription]</helptitle>",
            "args": [
            {
                "name": "add <PLAT-SPEC>",
                "description": "[CommandPluginAddSubcommandDescription]",
                "options": [
                {
                    "name": "[--searchpath <DIRECTORY>]", "description": "[CommandPluginSearchPathDescription]"
                }
                ,
                {
                    "name": "[--noregistry]", "description": "[CommandPluginNoRegistryDescription]"
                }
                ,
                {
                    "name": "[--link]", "description": "[CommandPluginLinkDescription]"
                }
                ,
                {
                    "name": "[--save]", "description": "[CommandPluginSaveAddDescription]"
                }
                ,
                {
                    "name": "[--shrinkwrap]", "description": "[CommandPluginShrinkwrapDescription]"
                }
                ,
                {
                    "name": "[--browserify]", "description": "[CommandPluginBrowserifyDescription]"
                }
                ]
            }
            ,
            {
                "name": "remove <PLUGINID> [...]",
                "description": "[CommandPluginRemoveSubcommandDescription]",
                "options": [
                {
                    "name": "[--save]", "description": "[CommandPluginSaveRemoveDescription]"
                }
                ]
            }
            ,
            {
                "name": "list", "description": "[CommandPluginListSubcommandDescription]"
            }
            ,
            {
                "name": "search", "description": "[CommandPluginSearchSubcommandDescription]"
            }
            ],
            "aliases": {
                "rm": "remove",
                "ls": "list"
            }
        }
        ,
        "install-reqs":
        {
            "synopsis": "<synopsis>[PLATFORM] [--OPTIONS]</synopsis>",
            "categoryTitle": "[ProjectCommandsTitle]",
            "modulePath": "./installReqs",
            "description": "<helptitle>[CommandInstallReqsDescription]</helptitle>",
            "args": [
            {
                "name": "[PLATFORM]", "description": "[CommandInstallReqsPlatformDescription]"
            }
            ],
            "options": [
            {
                "name": "--no-prompt", "description": "[CommandInstallReqsNoPromptDescription]"
            }
            ]
        }
        ,
        "remote":
        {
            "synopsis": "<synopsis>COMMAND</synopsis>",
            "categoryTitle": "[ProjectCommandsTitle]",
            "modulePath": "./remote",
            "description": "<helptitle>[CommandRemoteDescription]</helptitle>",
            "args": [
            {
                "name": "COMMAND", "description": "[CommandRemoteSubcommandDescription]"
            }
            ,
            {
                "name": "add <PLATFORM>",
                "description": "[CommandRemoteAddSubcommandDescription]"
            }
            ,
            {
                "name": "remove <PLATFORM>",
                "description": "[CommandRemoteRemoveSubcommandDescription]"
            }
            ,
            {
                "name": "list",
                "description": "[CommandRemoteListSubcommandDescription]"
            }
            ],
            "aliases": {
                "rm": "remove",
                "ls": "list"
            }
        }
        ,
        "build":
        {
            "synopsis": "<synopsis>[PLATFORM] [--OPTIONS]</synopsis>",
            "categoryTitle": "[ProjectCommandsTitle]",
            "modulePath": "./build",
            "description": "<helptitle>[CommandBuildDescription]</helptitle>",
            "args": [
            {
                "name": "PLATFORM", "description": "[CommandBuildPlatformDescription]"
            }
            ],
            "options": [
            {
                "name": "--remote", "description": "[CommandBuildRemoteDescription]"
            }
            ,
            {
                "name": "--local", "description": "[CommandBuildLocalDescription]"
            }
            ,
            {
                "name": "--clean", "description": "[CommandBuildCleanDescription]"
            }
            ,
            {
                "name": "--debug", "description": "[CommandBuildDebugDescription]"
            }
            ,
            {
                "name": "--release", "description": "[CommandBuildReleaseDescription]"
            }
            ,
            {
                "name": "--device", "description": "[CommandBuildDeviceDescription]"
            }
            ,
            {
                "name": "--emulator", "description": "[CommandBuildEmulatorDescription]"
            }
            ,
            {
                "name": "--target=TARGET", "description": "[CommandBuildTargetDescription]"
            }
            ]
        }
        ,
        "run":
        {
            "synopsis": "<synopsis>[PLATFORM] [--OPTIONS]</synopsis>",
            "categoryTitle": "[ProjectCommandsTitle]",
            "modulePath": "./run",
            "description": "<helptitle>[CommandRunDescription]</helptitle>",
            "args": [
            {
                "name": "PLATFORM", "description": "[CommandRunPlatformDescription]"
            }
            ],
            "options": [
            {
                "name": "--remote", "description": "[CommandRunRemoteDescription]"
            }
            ,
            {
                "name": "--local", "description": "[CommandRunLocalDescription]"
            }
            ,
            {
                "name": "--nobuild", "description": "[CommandRunNobuildDescription]"
            }
            ,
            {
                "name": "--debuginfo", "description": "[CommandRunDebuginfoDescription]"
            }
            ,
            {
                "name": "--debug", "description": "[CommandRunDebugDescription]"
            }
            ,
            {
                "name": "--release", "description": "[CommandRunReleaseDescription]"
            }
            ,
            {
                "name": "--device", "description": "[CommandRunDeviceDescription]"
            }
            ,
            {
                "name": "--emulator", "description": "[CommandRunEmulatorDescription]"
            }
            ,
            {
                "name": "--target=TARGET", "description": "[CommandRunTargetDescription]"
            },
            {
                "name":  "--list", "description": "[CommandRunListDescription]"
            },
            {
                "name":  "--livereload", "description": "[CommandRunLiveReloadDescription]",
                "options": [
                {
                    "name": "--tunnel", "description": "[CommandRunTunnelDescription]"
                },
                {
                    "name": "--ignore=PATTERN", "description": "[CommandRunIgnoreDescription]"
                }
                ]
            },
            {
                "name":  "--devicesync", "description": "[CommandRunDeviceSyncDescription]",
                "options": [
                {
                    "name": "--tunnel", "description": "[CommandRunTunnelDescription]"
                },
                {
                    "name": "--ignore=PATTERN", "description": "[CommandRunIgnoreDescription]"
                }
                ]
            }
            ],
            "examples": [
                { "example": "taco run --livereload --ignore=/**/*.css", "description": "[TacoRunLivereloadExample1]" },
                { "example": "taco run --livereload --tunnel" , "description": "[TacoRunLivereloadExample2]" }
            ]
        }
        ,
        "emulate":
        {
            "synopsis": "<synopsis>[PLATFORM] [--OPTIONS]</synopsis>",
            "categoryTitle": "[ProjectCommandsTitle]",
            "modulePath": "./emulate",
            "description": "<helptitle>[CommandEmulateDescription]</helptitle>",
            "args": [
            {
                "name": "PLATFORM", "description": "[CommandRunPlatformDescription]"
            }
            ],
            "options": [
            {
                "name": "--remote", "description": "[CommandRunRemoteDescription]"
            }
            ,
            {
                "name": "--local", "description": "[CommandRunLocalDescription]"
            }
            ,
            {
                "name": "--nobuild", "description": "[CommandRunNobuildDescription]"
            }
            ,
            {
                "name": "--debuginfo", "description": "[CommandRunDebuginfoDescription]"
            }
            ,
            {
                "name": "--debug", "description": "[CommandRunDebugDescription]"
            }
            ,
            {
                "name": "--release", "description": "[CommandRunReleaseDescription]"
            }
            ,
            {
                "name": "--target=TARGET", "description": "[CommandRunTargetDescription]"
            },
            {
                "name":  "--livereload", "description": "[CommandRunLiveReloadDescription]",
                "options": [
                {
                    "name": "--tunnel", "description": "[CommandRunTunnelDescription]"
                },
                {
                    "name": "--ignore=PATTERN", "description": "[CommandRunIgnoreDescription]"
                }
                ]
            },
            {
                "name":  "--devicesync", "description": "[CommandRunDeviceSyncDescription]",
                "options": [
                {
                    "name": "--tunnel", "description": "[CommandRunTunnelDescription]"
                },
                {
                    "name": "--ignore=PATTERN", "description": "[CommandRunIgnoreDescription]"
                }
                ]
            }
            ],
            "examples": [
                { "example": "taco emulate --livereload --ignore=/**/*.css", "description": "[TacoRunLivereloadExample1]" },
                { "example": "taco emulate --livereload --tunnel" , "description": "[TacoRunLivereloadExample2]" }
            ]
        }
        ,
        "help":
        {
            "synopsis": "<synopsis>[COMMAND]</synopsis>",
            "categoryTitle": "[GeneralCommandsTitle]",
            "modulePath": "./help",
            "description": "<helptitle>[CommandHelpDescription]</helptitle>"
        }
        ,
        "docs":
        {
            "synopsis": "<synopsis></synopsis>",
            "categoryTitle": "[GeneralCommandsTitle]",
            "modulePath": "./docs",
            "description": "<helptitle>[CommandDocumentationDescription]</helptitle>"
        }
        ,
        "version":
        {
            "synopsis": "<synopsis></synopsis>",
            "categoryTitle": "[GeneralCommandsTitle]",
            "modulePath": "./version",
            "description": "<helptitle>[CommandVersionDescription]</helptitle>"
        },
        "feedback":
        {
            "synopsis": "<synopsis></synopsis>",
            "categoryTitle": "[GeneralCommandsTitle]",
            "modulePath": "./feedback",
            "description": "<helptitle>[CommandFeedbackDescription]</helptitle>"
        }
    },
    "aliases":
    {
        "platforms": "platform",
        "plugins": "plugin",
        "template":  "templates"
    }
}