NAME

appspec - Utilities for spec files for App::Spec cli apps

ABSTRACT

DESCRIPTION

This script is a collection of tools for authors of App::Spec command line scripts.

  # generate completion
  % appspec completion --bash path/to/spec.yaml
  # generate pod
  % appspec pod path/to/spec.yaml
  # validate your spec file
  % appspec validate path/to/spec.yaml
  # generate a new App::Spec app skeleton
  % appspec new --class App::foo --name foo --with-subcommands

GLOBAL OPTIONS

    --help -h    Show command help (flag)

SUBCOMMANDS

completion

    appspec  completion [options] <spec_file>

Generate completion for a specified spec file

This command takes a spec file and outputs the corresponding shell script for tab completion.

Options:

    --name    name of the program (optional, override the value from the spec)
    --zsh     for zsh (flag)                                                  
    --bash    for bash (flag)                                                 

Parameters:

    spec_file  *  Path to the spec file (use '-' for standard input)

new

    appspec  new [options] [<path>]

Create new app

This command creates a skeleton for a new app. It will create a directory for your app and write a skeleton spec file.

Example:

  appspec new --name myprogram --class App::MyProgram App-MyProgram

Options:

    --name -n              *  The (file) name of the app                     
    --class -c             *  The main class name for your app implementation
    --overwrite -o            Overwrite existing dist directory (flag)       
    --with-subcommands -s     Create an app with subcommands (flag)          

Parameters:

    path    Path to the distribution directory (default is 'Dist-Name' in current directory)

pod

    appspec  pod <spec_file>

Generate pod

This command takes a spec file and outputs the generated pod documentation.

Parameters:

    spec_file  *  Path to the spec file (use '-' for standard input)

validate

    appspec  validate [options] <spec_file>

Validate spec file

This command takes a spec file and validates it against the current App::Spec schema.

Options:

    --color -C    output colorized (flag)

Parameters:

    spec_file  *  Path to the spec file (use '-' for standard input)

help

    appspec  help <subcommands> [options]

Show command help

Options:

    --all     (flag)

_meta

    appspec  _meta <subcommands>

Information and utilities for this app

_meta completion

    appspec _meta completion <subcommands>

Shell completion functions

_meta completion generate

    appspec _meta completion generate [options]

Generate self completion

Options:

    --name    name of the program (optional, override name in spec)
    --zsh     for zsh (flag)                                       
    --bash    for bash (flag)                                      

_meta pod

    appspec _meta pod <subcommands>

Pod documentation

_meta pod generate

    appspec _meta pod generate

Generate self pod