vspd/cmd/vspadmin/README.md
jholdstock 997205ed95 vspadmin: New binary to create empty databases.
vspadmin is a new binary which implements one-off admin tasks which are
necessarily interactive and thus do not fit neatly into the long-lived
vspd binary.

The first behaviour added to vspadmin is the ability to create a new
vspd database. This behaviour is removed from vspd with the associated
config option deprecated. Documentation and scripts updated to reflect
the change.
2024-06-19 09:35:41 +01:00

31 lines
630 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>
```