Merge pull request #210 from guggero/command-generator

doc: add static command generator helper page

Author: guggero

Makefile

@@ -89,6 +89,11 @@ docker-tools:
 	@$(call print, "Building tools docker image.")
 	docker build -q -t chantools-tools $(TOOLS_DIR)
 
+command-generator-build:
+	@$(call print, "Building command generator.")
+	cd doc/command-generator; npm install && npm run build
+	mv doc/command-generator/dist/index.html doc/command-generator.html
+
 fmt: $(GOIMPORTS_BIN)
 	@$(call print, "Fixing imports.")
 	gosimports -w $(GOFILES_NOVENDOR)
@@ -99,7 +104,7 @@ lint: docker-tools
 	@$(call print, "Linting source.")
 	$(DOCKER_TOOLS) golangci-lint run -v $(LINT_WORKERS)
 
-docs: install
+docs: install command-generator-build
 	@$(call print, "Rendering docs.")
 	chantools doc
 

doc/chantools.md

@@ -12,11 +12,12 @@ https://github.com/lightninglabs/chantools/.
 ### Options
 
 ```
-  -h, --help        help for chantools
-      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
-  -r, --regtest     Indicates if regtest parameters should be used
-  -s, --signet      Indicates if the public signet parameters should be used
-  -t, --testnet     Indicates if testnet parameters should be used
+  -h, --help                help for chantools
+      --nologfile           If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest             Indicates if regtest parameters should be used
+      --resultsdir string   Directory where results should be stored (default "./results")
+  -s, --signet              Indicates if the public signet parameters should be used
+  -t, --testnet             Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO

doc/chantools_chanbackup.md

@@ -33,10 +33,11 @@ chantools chanbackup \
 ### Options inherited from parent commands
 
 ```
-      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
-  -r, --regtest     Indicates if regtest parameters should be used
-  -s, --signet      Indicates if the public signet parameters should be used
-  -t, --testnet     Indicates if testnet parameters should be used
+      --nologfile           If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest             Indicates if regtest parameters should be used
+      --resultsdir string   Directory where results should be stored (default "./results")
+  -s, --signet              Indicates if the public signet parameters should be used
+  -t, --testnet             Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO

doc/chantools_closepoolaccount.md

@@ -48,10 +48,11 @@ chantools closepoolaccount \
 ### Options inherited from parent commands
 
 ```
-      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
-  -r, --regtest     Indicates if regtest parameters should be used
-  -s, --signet      Indicates if the public signet parameters should be used
-  -t, --testnet     Indicates if testnet parameters should be used
+      --nologfile           If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest             Indicates if regtest parameters should be used
+      --resultsdir string   Directory where results should be stored (default "./results")
+  -s, --signet              Indicates if the public signet parameters should be used
+  -t, --testnet             Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO

doc/chantools_compactdb.md

@@ -31,10 +31,11 @@ chantools compactdb \
 ### Options inherited from parent commands
 
 ```
-      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
-  -r, --regtest     Indicates if regtest parameters should be used
-  -s, --signet      Indicates if the public signet parameters should be used
-  -t, --testnet     Indicates if testnet parameters should be used
+      --nologfile           If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest             Indicates if regtest parameters should be used
+      --resultsdir string   Directory where results should be stored (default "./results")
+  -s, --signet              Indicates if the public signet parameters should be used
+  -t, --testnet             Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO

doc/chantools_createwallet.md

@@ -33,10 +33,11 @@ chantools createwallet \
 ### Options inherited from parent commands
 
 ```
-      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
-  -r, --regtest     Indicates if regtest parameters should be used
-  -s, --signet      Indicates if the public signet parameters should be used
-  -t, --testnet     Indicates if testnet parameters should be used
+      --nologfile           If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest             Indicates if regtest parameters should be used
+      --resultsdir string   Directory where results should be stored (default "./results")
+  -s, --signet              Indicates if the public signet parameters should be used
+  -t, --testnet             Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO

doc/chantools_deletepayments.md

@@ -34,10 +34,11 @@ chantools deletepayments --failedonly \
 ### Options inherited from parent commands
 
 ```
-      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
-  -r, --regtest     Indicates if regtest parameters should be used
-  -s, --signet      Indicates if the public signet parameters should be used
-  -t, --testnet     Indicates if testnet parameters should be used
+      --nologfile           If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest             Indicates if regtest parameters should be used
+      --resultsdir string   Directory where results should be stored (default "./results")
+  -s, --signet              Indicates if the public signet parameters should be used
+  -t, --testnet             Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO

doc/chantools_derivekey.md

@@ -36,10 +36,11 @@ chantools derivekey --identity
 ### Options inherited from parent commands
 
 ```
-      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
-  -r, --regtest     Indicates if regtest parameters should be used
-  -s, --signet      Indicates if the public signet parameters should be used
-  -t, --testnet     Indicates if testnet parameters should be used
+      --nologfile           If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest             Indicates if regtest parameters should be used
+      --resultsdir string   Directory where results should be stored (default "./results")
+  -s, --signet              Indicates if the public signet parameters should be used
+  -t, --testnet             Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO

doc/chantools_doublespendinputs.md

@@ -40,10 +40,11 @@ chantools doublespendinputs \
 ### Options inherited from parent commands
 
 ```
-      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
-  -r, --regtest     Indicates if regtest parameters should be used
-  -s, --signet      Indicates if the public signet parameters should be used
-  -t, --testnet     Indicates if testnet parameters should be used
+      --nologfile           If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest             Indicates if regtest parameters should be used
+      --resultsdir string   Directory where results should be stored (default "./results")
+  -s, --signet              Indicates if the public signet parameters should be used
+  -t, --testnet             Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO

doc/chantools_dropchannelgraph.md

@@ -44,10 +44,11 @@ chantools dropchannelgraph \
 ### Options inherited from parent commands
 
 ```
-      --nologfile   If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
-  -r, --regtest     Indicates if regtest parameters should be used
-  -s, --signet      Indicates if the public signet parameters should be used
-  -t, --testnet     Indicates if testnet parameters should be used
+      --nologfile           If set, no log file will be created. This is useful for testing purposes where we don't want to create a log file.
+  -r, --regtest             Indicates if regtest parameters should be used
+      --resultsdir string   Directory where results should be stored (default "./results")
+  -s, --signet              Indicates if the public signet parameters should be used
+  -t, --testnet             Indicates if testnet parameters should be used
 ```
 
 ### SEE ALSO