vspd/cmd/vspadmin/README.md
jholdstock 4e5fec8f3b vspadmin: Write default config file.
A new command in vspadmin writes the default config file for a new vspd
deployment. The behaviour is removed from vspd and documentation has
been updated to reflect the change.
2024-06-19 09:35:41 +01:00

41 lines
793 B
Markdown

# vspadmin
vspadmin is a tool to perform various VSP administration tasks.
## Usage
```no-highlight
vspadmin [OPTIONS] COMMAND
```
## Options
```no-highlight
--homedir= Path to application home directory. (default: /home/user/.vspd)
--network=[mainnet|testnet|simnet] Decred network to use. (default: mainnet)
-h, --help Show help message
```
## Commands
### `createdatabase`
Creates a new database for a new deployment of vspd. Accepts the xpub key to be
used for collecting fees as a parameter.
Example:
```no-highlight
$ go run ./cmd/vspadmin createdatabase <xpub>
```
### `writeconfig`
Writes a config file with default values to the application home directory.
Example:
```no-highlight
$ go run ./cmd/vspadmin writeconfig
```