Add CLI docs

Signed-off-by: jolheiser <john.olheiser@gmail.com>
pull/7/head
jolheiser 2020-11-16 23:43:07 -06:00
parent 6de6e4ef70
commit c5bf199b84
Signed by: jolheiser
GPG Key ID: B853ADA5DA7BBF7A
2 changed files with 86 additions and 0 deletions

82
DOCS.md 100644
View File

@ -0,0 +1,82 @@
# NAME
tmpl - Template automation
# SYNOPSIS
tmpl
```
[--debug|-d]
[--registry|-r]=[value]
[--source|-s]=[value]
```
**Usage**:
```
tmpl [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]
```
# GLOBAL OPTIONS
**--debug, -d**: Debug mode
**--registry, -r**="": Registry directory of tmpl (default: /home/jolheiser/.tmpl)
**--source, -s**="": Short-name source to use
# COMMANDS
## download
Download a template
**--branch, -b**="": Branch to clone (default: main)
## init
Initialize a template
## list
List templates in the registry
## remove
Remove a template
## save
Save a local template
**--branch, -b**="": Branch to clone (default: main)
## source
Commands for working with sources
### list
List available sources
### add
AddTemplate a source
### remove
RemoveTemplate a source
## test
Test if a directory is a valid template
## update
Update a template
## use
Use a template

View File

@ -16,3 +16,7 @@ fmt:
.PHONY: test
test:
$(GO) test -race ./...
.PHONY: docs
docs:
$(GO) run docs.go