diff --git a/DOCS.md b/DOCS.md new file mode 100644 index 0000000..3dce5d7 --- /dev/null +++ b/DOCS.md @@ -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 diff --git a/Makefile b/Makefile index 13f5a8d..6023d00 100644 --- a/Makefile +++ b/Makefile @@ -16,3 +16,7 @@ fmt: .PHONY: test test: $(GO) test -race ./... + +.PHONY: docs +docs: + $(GO) run docs.go