Footing CLI¶
The main footing command and its subcommands are listed below. Note that
--help can be given as an argument to any of these commands to print
out help on the command line.
footing¶
footing [OPTIONS] COMMAND [ARGS]...
Options
- --version¶
Show version
clean¶
Cleans temporary resources created by footing, such as the footing update branch
footing clean [OPTIONS]
ls¶
List packages created with footing. Enter a git forge path, such as a Github user or Gitlab group URL, to list all templates under the forge. Provide the template path as the second argument to list all projects that have been started with that template.
Use “-l” to print the repository descriptions of templates or projects.
footing ls [OPTIONS] FORGE [TEMPLATE]
Options
- -l, --long-format¶
Print extended information about results
Arguments
- FORGE¶
Required argument
- TEMPLATE¶
Optional argument
setup¶
Setup new project. Takes a git path to the template as returned by “footing ls”. In order to start a project from a particular version (instead of the latest), use the “-v” option.
footing setup [OPTIONS] TEMPLATE
Options
- -v, --version <version>¶
Git SHA or branch of template to use for creation
Arguments
- TEMPLATE¶
Required argument
switch¶
Switch a project’s template to a different template.
footing switch [OPTIONS] TEMPLATE
Options
- -v, --version <version>¶
Git SHA or branch of template to use for update
Arguments
- TEMPLATE¶
Required argument
update¶
Update package with latest template. Must be inside of the project folder to run.
Using “-e” will prompt for re-entering the template parameters again even if the project is up to date.
Use “-v” to update to a particular version of a template.
Using “-c” will perform a check that the project is up to date with the latest version of the template (or the version specified by “-v”). No updating will happen when using this option.
footing update [OPTIONS]
Options
- -c, --check¶
Check to see if up to date
- -e, --enter-parameters¶
Enter template parameters on update
- -v, --version <version>¶
Git SHA or branch of template to use for update