github.com/jduhamel/gcli@v0.2.4-0.20151019142748-0d5307cd7e21/doc.go (about)

     1  // DO NOT EDIT THIS FILE.
     2  // THIS FILE IS GENERATED BY GO GENERATE.
     3  
     4  /*
     5  Command gcli generates a skeleon (codes and its directory structure) you need to start building CLI tool by Golang.
     6  https://github.com/tcnksm/gcli
     7  
     8  Usage:
     9  
    10      gcli [-version] [-help]  <command> [<options>]
    11  
    12  Available commands:
    13  
    14      apply       Apply design template file for generating cli project
    15      design      Generate project design template
    16      list        List available cli frameworks
    17      new         Generate new cli project
    18      validate    Validate design template file
    19  
    20  Use "gcli <command> -help" for more information about command.
    21  
    22  
    23  
    24  Apply design template file for generating cli project
    25  
    26  Apply design template file for generating cli project. You can generate
    27  design template file via 'gcli design' command. If framework name is not
    28  specified gcli use codegangsta/cli. You can set framework name via '-F'
    29  option. To check cli framework you can use, run 'gcli list'. 
    30  
    31  Usage:
    32  
    33    gcli apply [option] FILE
    34  
    35  
    36  Options:
    37  
    38     -framework=name, -F        Cli framework name. By default, gcli use "codegangsta/cli"
    39                                To check cli framework you can use, run 'gcli list'.
    40                                If you set invalid framework, it will be failed.
    41  
    42     -skip-test, -T             Skip generating *_test.go file. By default, gcli generates
    43                                test file If you specify this flag, gcli will not generate
    44                                test files.
    45  
    46  
    47  
    48  Generate project design template
    49  
    50  Generate project design template (as toml file). You can pass that file to 'gcli apply'
    51  command and generate CLI tool based on template file. You can define what command
    52  and what flag you need on that file.
    53  
    54  Usage:
    55  
    56    gcli design [option] NAME
    57  
    58  
    59  Options:
    60  
    61    -command=name, -c           Command name which you want to add.
    62                                This is valid only when cli pacakge support commands.
    63                                This can be specified multiple times. Synopsis can be
    64                                set after ":". Namely, you can specify command by 
    65                                -command=NAME:SYNOPSYS. Only NAME is required.
    66                                You can set multiple variables at same time with ","
    67                                separator.
    68  
    69    -flag=name, -f              Global flag option name which you want to add.
    70                                This can be specified multiple times. By default, flag type
    71                                is string and its description is empty. You can set them,
    72                                with ":" separator. Namaly, you can specify flag by
    73                                -flag=NAME:TYPE:DESCIRPTION. Order must be flow  this and
    74                                TYPE must be string, bool or int. Only NAME is required.
    75                                You can set multiple variables at same time with ","
    76                                separator.
    77  
    78    -framework=name, -F         Cli framework name. By default, gcli use "codegangsta/cli"
    79                                To check cli framework you can use, run 'gcli list'.
    80                                If you set invalid framework, it will be failed.
    81  
    82    -owner=name, -o             Command owner (author) name. This value is also used for
    83                                import path name. By default, owner name is extracted from
    84                                ~/.gitconfig variable.
    85  
    86  
    87    -output, -O                 Change output file name. By default, gcli use "NAME-design.toml"
    88  
    89  
    90  
    91  List available cli frameworks
    92  
    93  Show all avairable cli frameworks.
    94  
    95  Usage:
    96  
    97    gcli list
    98  
    99  
   100  
   101  Generate new cli project
   102  
   103  Generate new cli skeleton project. At least, you must provide executable
   104  name. You can select cli package and set commands via command line option.
   105  See more about that on Options section. By default, gcli use codegangsta/cli.
   106  To check cli framework you can use, run 'gcli list'. 
   107  
   108  Usage:
   109  
   110      gcli new [option] NAME
   111  
   112  Options:
   113  
   114    -command=name, -c           Command name which you want to add.
   115                                This is valid only when cli pacakge support commands.
   116                                This can be specified multiple times. Synopsis can be
   117                                set after ":". Namely, you can specify command by 
   118                                -command=NAME:SYNOPSYS. Only NAME is required.
   119                                You can set multiple variables at same time with ","
   120                                separator.
   121  
   122    -flag=name, -f              Global flag option name which you want to add.
   123                                This can be specified multiple times. By default, flag type
   124                                is string and its description is empty. You can set them,
   125                                with ":" separator. Namaly, you can specify flag by
   126                                -flag=NAME:TYPE:DESCIRPTION. Order must be flow  this and
   127                                TYPE must be string, bool or int. Only NAME is required.
   128                                You can set multiple variables at same time with ","
   129                                separator.
   130  
   131     -framework=name, -F        Cli framework name. By default, gcli use "codegangsta/cli"
   132                                To check cli framework you can use, run 'gcli list'.
   133                                If you set invalid framework, it will be failed.
   134  
   135     -owner=name, -o            Command owner (author) name. This value is also used for
   136                                import path name. By default, owner name is extracted from
   137                                ~/.gitconfig variable.
   138  
   139     -skip-test, -T             Skip generating *_test.go file. By default, gcli generates
   140                                test file If you specify this flag, gcli will not generate
   141                                test files.
   142  
   143  Examples:
   144  
   145  To create todo command application skeleton which has 'add' and 'delete' command,
   146  
   147     $ gcli new -command=add:"Add new task" -commnad=delete:"delete task" todo
   148  
   149  
   150  
   151  Validate design template file
   152  
   153  Validate design template file which has required filed. If not it returns
   154  error and non zero value. 
   155  
   156  Usage:
   157  
   158    gcli validate FILE
   159  
   160  
   161  
   162  */
   163  package main