Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 1.93 KB

gli.rdoc

File metadata and controls

51 lines (34 loc) · 1.93 KB

gli

gli allows you to create the scaffolding for a GLI-powered application

gli [global options] command_name [command-specific options] [--] arguments...
  • Use the command help to get a summary of commands

  • Use the command help command_name to get a help for command_name

  • Use -- to stop command line argument processing; useful if your arguments have dashes in them

Global Options

These options are available for any command and are specified before the name of the command

-n

Dry run; dont change the disk

-r, --root=arg

Root dir of project ( default: .)

This is the directory where the projects directory will be made, so if you specify a project name foo and the root dir of ., the directory ./foo will be created

-v

Be verbose

Commands

help

Shows list of commands or help for one command

init

Create a new GLI-based project

help [command]

Shows list of commands or help for one command

Gets help for the application or its commands. Can also list the commands in a way helpful to creating a bash-style completion function

Options

These options are specified after the command.

-c, --completion

List all commands one line at a time, for use with shell completion ([command] argument is partial command to match)

init project_name [command[ command]*]

Create a new GLI-based project

Aliases

  • scaffold

This will create a scaffold command line project that uses GLI for command line processing. Specifically, this will create an executable ready to go, as well as a lib and test directory, all inside the directory named for your project

Options

These options are specified after the command.

-e, --ext

Create an ext dir

--force

Overwrite/ignore existing files and directories

--notest

Do not create a test dir