lib/rigit/docopt.txt
Rigit
Usage:
rig new NAME
rig build RIG [--force] [PARAMS...]
rig install RIG REPO
rig uninstall RIG
rig update RIG
rig info RIG
rig list [SUBFOLDER]
rig (-h|--help|--version)
Commands:
new
Create a new rig template.
build
Create a new project based on one of the installed rig templates.
This command should be executed in an empty directory.
In case the rig has arguments, you will be prompted to input them.
If you wish to execute this command without interactivity, you may
use specify all parameters in the PARAMS parameter (see below).
install
Clone a remote rig git repository and install it locally.
uninstall
Remove an installed rig.
update
Update an installed rig to its latest version.
info
Show some meta information about an installed rig.
list
Show a list of installed rigs. If a subfolder is provided, show a list
of subfolders (possibly rigs) inside it.
Parameters:
NAME
The name of the new rig template.
RIG
The name of the source folder (installed rig).
REPO
A git repository containing rig configuration.
Use the 'clone URL' for the repository.
PARAMS
Specify any of the rig's parameters in the format 'param=value'.
For boolean parameters, use 'param=y' or 'param=n'.
SUBFOLDER
A folder inside your rigs directory.
Options:
-f --force
Overwrite existing files without prompting.
-h --help
Show this screen.
--version
Show version number.
Environment Variables:
RIG_HOME
The path where your local rigs are installed (default: ~/.rigs).
Examples:
rig build gem name=mygem spec=y
rig install example https://github.com/DannyBen/example-rig.git
rig uninstall example
rig update example
rig info example
rig list
rig new myrig