Home

tmpl @main - refs - log -
-
https://git.jolheiser.com/tmpl.git
Template automation
tree log patch
Add CLI docs Signed-off-by: jolheiser <john.olheiser@gmail.com>
Signature
-----BEGIN PGP SIGNATURE----- iQIzBAABCgAdFiEEgqEQpE3xoo1QwJO/uFOtpdp7v3oFAl+zYusACgkQuFOtpdp7 v3oVUw//ffTxGVHMtEVSJ+qNPvOvP0DOHXAncTYD/521mt5VTO7RLcGbta4AR3R0 FcJAHGkbCt8h12ZeDM7G+zIlTrtINrB+7RiTQAQ7eceRyRw4S9afPesG6UNQd4i/ ma3ma2Y0oSjW8oW5WhEAJtFkmAm70xNV/5TL/4fMLjZAorT/24RQM6a8CYxnb8vZ Tn6GoY7C17y/kCDAWV8YZUeLYsGhs+bf7pUh71lSw4xjsRhtZ8FnsHfN9+96ZiLO o21Zjnf6MdFfWQTWDOmqX6otyurSPIBrnfM/pU/WDkUmikAqaxWVIhGbzgcvS+aK tnvzHGgaePJRWwNASHvofidQldta0/f6EHr77QrmukiUMY2vP+KLtNLfpkgH85kt XrX0vA4/UCYW0I94Rwd+Tj02jOuOSDz900G2BP0WtFQY9vhb8UiP1ygaXvcApkRh QrR0lQuDtDYRrA3Z/tkucwWPB9R6a2GzFNf7riszpMLv3wTgCJ98XcRGeUNYnecM F/N8VAt/cSgxudxy6/Tg2Z3Xj6NQHw7LxlImpfZik8j0qT4sPGVIqulNg3eRpDi2 JoOa64MhJ55W+0U8PjhXgMl3bWvkxwtowk1kEnk/xpo4gLbnBFtxhphmyBN5aR05 zu9md8RJrCVjKK2xYgxB2gRBPxCjIUE1MHt+qaCMutTv2HpefWA= =C/wG -----END PGP SIGNATURE-----
jolheiser <john.olheiser@gmail.com>
3 years ago
2 changed files, 86 additions(+), 0 deletions(-)
I DOCS.md
diff --git a/DOCS.md b/DOCS.md
new file mode 100644
index 0000000000000000000000000000000000000000..3dce5d7025cf9f97cd06a16fb6081224043b5046
--- /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
M Makefile -> Makefile
diff --git a/Makefile b/Makefile
index 13f5a8d8846816cb20c2b6cc2a17beb1dd3792d9..6023d0069ab58e7c7177230d6f95357e90e7be61 100644
--- a/Makefile
+++ b/Makefile
@@ -16,3 +16,7 @@
 .PHONY: test
 test:
 	$(GO) test -race ./...
+
+.PHONY: docs
+docs:
+	$(GO) run docs.go