doc: generate docs with cobra

Author: guggero

Makefile

@@ -80,3 +80,7 @@ fmt:
 lint: $(LINT_BIN)
 	@$(call print, "Linting source.")
 	$(LINT)
+
+docs: install
+	@$(call print, "Rendering docs.")
+	chantools doc

README.md

@@ -64,6 +64,7 @@ var rootCmd = &cobra.Command{
 		log.Infof("chantools version v%s commit %s", version,
 			Commit)
 	},
+	DisableAutoGenTag: true,
 }
 
 func init() {
@@ -82,6 +83,7 @@ func init() {
 		newDeriveKeyCommand(),
 		newDumpBackupCommand(),
 		newDumpChannelsCommand(),
+		newDocCommand(),
 		newFilterBackupCommand(),
 		newFixOldBackupCommand(),
 		newForceCloseCommand(),

cmd/chantools/root.go

@@ -0,0 +1,42 @@
+## chantools
+
+Chantools helps recover funds from lightning channels
+
+### Synopsis
+
+This tool provides helper functions that can be used rescue
+funds locked in lnd channels in case lnd itself cannot run
+properly anymore.
+
+Complete documentation is available at https://github.com/guggero/chantools/.
+
+### Options
+
+```
+  -h, --help      help for chantools
+  -r, --regtest   Indicates if regtest parameters should be used
+  -t, --testnet   Indicates if testnet parameters should be used
+```
+
+### SEE ALSO
+
+* [chantools chanbackup](chantools_chanbackup.md)	 - Create a channel.backup file from a channel database
+* [chantools compactdb](chantools_compactdb.md)	 - Create a copy of a channel.db file in safe/read-only mode
+* [chantools derivekey](chantools_derivekey.md)	 - Derive a key with a specific derivation path
+* [chantools dumpbackup](chantools_dumpbackup.md)	 - Dump the content of a channel.backup file
+* [chantools dumpchannels](chantools_dumpchannels.md)	 - Dump all channel information from an lnd channel database
+* [chantools filterbackup](chantools_filterbackup.md)	 - Filter an lnd channel.backup file and remove certain channels
+* [chantools fixoldbackup](chantools_fixoldbackup.md)	 - Fixes an old channel.backup file that is affected by the lnd issue #3881 (unable to derive shachain root key)
+* [chantools forceclose](chantools_forceclose.md)	 - Force-close the last state that is in the channel.db provided
+* [chantools genimportscript](chantools_genimportscript.md)	 - Generate a script containing the on-chain keys of an lnd wallet that can be imported into other software like bitcoind
+* [chantools removechannel](chantools_removechannel.md)	 - Remove a single channel from the given channel DB
+* [chantools rescueclosed](chantools_rescueclosed.md)	 - Try finding the private keys for funds that are in outputs of remotely force-closed channels
+* [chantools rescuefunding](chantools_rescuefunding.md)	 - Rescue funds locked in a funding multisig output that never resulted in a proper channel; this is the command the initiator of the channel needs to run
+* [chantools showrootkey](chantools_showrootkey.md)	 - Extract and show the BIP32 HD root key from the 24 word lnd aezeed
+* [chantools signrescuefunding](chantools_signrescuefunding.md)	 - Rescue funds locked in a funding multisig output that never resulted in a proper channel; this is the command the remote node (the non-initiator) of the channel needs to run
+* [chantools summary](chantools_summary.md)	 - Compile a summary about the current state of channels
+* [chantools sweeptimelock](chantools_sweeptimelock.md)	 - Sweep the force-closed state after the time lock has expired
+* [chantools sweeptimelockmanual](chantools_sweeptimelockmanual.md)	 - Sweep the force-closed state of a single channel manually if only a channel backup file is available
+* [chantools vanitygen](chantools_vanitygen.md)	 - Generate a seed with a custom lnd node identity public key that starts with the given prefix
+* [chantools walletinfo](chantools_walletinfo.md)	 - Shows info about an lnd wallet.db file and optionally extracts the BIP32 HD root key
+

doc/chantools.md

@@ -0,0 +1,29 @@
+## chantools chanbackup
+
+Create a channel.backup file from a channel database
+
+```
+chantools chanbackup [flags]
+```
+
+### Options
+
+```
+      --bip39               read a classic BIP39 seed and passphrase from the terminal instead of asking for lnd seed format or providing the --rootkey flag
+      --channeldb string    lnd channel.db file to create the backup from
+  -h, --help                help for chanbackup
+      --multi_file string   lnd channel.backup file to create
+      --rootkey string      BIP32 HD root key of the wallet to use for creating the backup; leave empty to prompt for lnd 24 word aezeed
+```
+
+### Options inherited from parent commands
+
+```
+  -r, --regtest   Indicates if regtest parameters should be used
+  -t, --testnet   Indicates if testnet parameters should be used
+```
+
+### SEE ALSO
+
+* [chantools](chantools.md)	 - Chantools helps recover funds from lightning channels
+

doc/chantools_chanbackup.md

@@ -0,0 +1,28 @@
+## chantools compactdb
+
+Create a copy of a channel.db file in safe/read-only mode
+
+```
+chantools compactdb [flags]
+```
+
+### Options
+
+```
+      --destdb string     new lnd channel.db file to copy the compacted database to
+  -h, --help              help for compactdb
+      --sourcedb string   lnd channel.db file to create the database backup from
+      --txmaxsize int     maximum transaction size (default 65536)
+```
+
+### Options inherited from parent commands
+
+```
+  -r, --regtest   Indicates if regtest parameters should be used
+  -t, --testnet   Indicates if testnet parameters should be used
+```
+
+### SEE ALSO
+
+* [chantools](chantools.md)	 - Chantools helps recover funds from lightning channels
+

doc/chantools_compactdb.md

@@ -0,0 +1,29 @@
+## chantools derivekey
+
+Derive a key with a specific derivation path
+
+```
+chantools derivekey [flags]
+```
+
+### Options
+
+```
+      --bip39            read a classic BIP39 seed and passphrase from the terminal instead of asking for lnd seed format or providing the --rootkey flag
+  -h, --help             help for derivekey
+      --neuter           don't output private key(s), only public key(s)
+      --path string      BIP32 derivation path to derive; must start with "m/"
+      --rootkey string   BIP32 HD root key of the wallet to use for decrypting the backup; leave empty to prompt for lnd 24 word aezeed
+```
+
+### Options inherited from parent commands
+
+```
+  -r, --regtest   Indicates if regtest parameters should be used
+  -t, --testnet   Indicates if testnet parameters should be used
+```
+
+### SEE ALSO
+
+* [chantools](chantools.md)	 - Chantools helps recover funds from lightning channels
+

doc/chantools_derivekey.md

@@ -0,0 +1,28 @@
+## chantools dumpbackup
+
+Dump the content of a channel.backup file
+
+```
+chantools dumpbackup [flags]
+```
+
+### Options
+
+```
+      --bip39               read a classic BIP39 seed and passphrase from the terminal instead of asking for lnd seed format or providing the --rootkey flag
+  -h, --help                help for dumpbackup
+      --multi_file string   lnd channel.backup file to dump
+      --rootkey string      BIP32 HD root key of the wallet to use for decrypting the backup; leave empty to prompt for lnd 24 word aezeed
+```
+
+### Options inherited from parent commands
+
+```
+  -r, --regtest   Indicates if regtest parameters should be used
+  -t, --testnet   Indicates if testnet parameters should be used
+```
+
+### SEE ALSO
+
+* [chantools](chantools.md)	 - Chantools helps recover funds from lightning channels
+

doc/chantools_dumpbackup.md

@@ -0,0 +1,27 @@
+## chantools dumpchannels
+
+Dump all channel information from an lnd channel database
+
+```
+chantools dumpchannels [flags]
+```
+
+### Options
+
+```
+      --channeldb string   lnd channel.db file to dump channels from
+      --closed             dump closed channels instead of open
+  -h, --help               help for dumpchannels
+```
+
+### Options inherited from parent commands
+
+```
+  -r, --regtest   Indicates if regtest parameters should be used
+  -t, --testnet   Indicates if testnet parameters should be used
+```
+
+### SEE ALSO
+
+* [chantools](chantools.md)	 - Chantools helps recover funds from lightning channels
+

doc/chantools_dumpchannels.md

@@ -0,0 +1,29 @@
+## chantools filterbackup
+
+Filter an lnd channel.backup file and remove certain channels
+
+```
+chantools filterbackup [flags]
+```
+
+### Options
+
+```
+      --bip39               read a classic BIP39 seed and passphrase from the terminal instead of asking for lnd seed format or providing the --rootkey flag
+      --discard string      comma separated list of channel funding outpoints (format <fundingTXID>:<index>) to remove from the backup file
+  -h, --help                help for filterbackup
+      --multi_file string   lnd channel.backup file to filter
+      --rootkey string      BIP32 HD root key of the wallet to use for decrypting the backup; leave empty to prompt for lnd 24 word aezeed
+```
+
+### Options inherited from parent commands
+
+```
+  -r, --regtest   Indicates if regtest parameters should be used
+  -t, --testnet   Indicates if testnet parameters should be used
+```
+
+### SEE ALSO
+
+* [chantools](chantools.md)	 - Chantools helps recover funds from lightning channels
+