ubdcc CLI¶
The ubdcc command-line interface manages a local UBDCC cluster (start,
status, stop, credentials). See the start subcommand for the interactive
shell commands available at runtime (add-dcn, remove-dcn, status,
restart, stop, help).
ubdcc¶
UNICORN Binance DepthCache Cluster — Cluster Manager https://github.com/oliver-zehentleitner/unicorn-binance-depth-cache-cluster
usage: ubdcc [-h] [-v] {start,status,stop,credentials} ...
- -h, --help¶
show this help message and exit
- -v, --version¶
show program’s version number and exit
- Credentials subcommands (use “ubdcc credentials <cmd> –help” for details):
credentials add Add a Binance API key/secret credentials remove Remove credentials by id credentials list List configured credentials (keys masked)
- Interactive shell commands (available inside “ubdcc start”):
add-dcn [count] Spawn new DCN process(es) remove-dcn <count|name> Stop and remove DCN(s) status Show cluster status restart <name> Restart a specific pod stop Shut down the cluster help Show available shell commands
ubdcc credentials¶
usage: ubdcc credentials [-h] {add,remove,list} ...
- -h, --help¶
show this help message and exit
ubdcc credentials add¶
usage: ubdcc credentials add [-h] --account-group ACCOUNT_GROUP --api-key API_KEY --api-secret API_SECRET [--port PORT]
- -h, --help¶
show this help message and exit
- --account-group <account_group>¶
binance.com | binance.com-testnet | binance.com-futures-testnet | binance.us | binance.tr
- --api-key <api_key>¶
- --api-secret <api_secret>¶
- --port <port>¶
Mgmt port (default: 42080)
ubdcc credentials list¶
usage: ubdcc credentials list [-h] [--port PORT]
- -h, --help¶
show this help message and exit
- --port <port>¶
Mgmt port (default: 42080)
ubdcc credentials remove¶
usage: ubdcc credentials remove [-h] [--port PORT] id
- id¶
- -h, --help¶
show this help message and exit
- --port <port>¶
Mgmt port (default: 42080)
ubdcc start¶
usage: ubdcc start [-h] [--dcn DCN] [--port PORT] [--logdir LOGDIR]
- -h, --help¶
show this help message and exit
- --dcn <dcn>¶
Number of DCN processes (default: 1)
- --port <port>¶
Mgmt port (default: 42080 or next free)
- --logdir <logdir>¶
Log directory (default: current directory)
ubdcc status¶
usage: ubdcc status [-h] [--port PORT]
- -h, --help¶
show this help message and exit
- --port <port>¶
Mgmt port (default: 42080)
ubdcc stop¶
usage: ubdcc stop [-h] [--port PORT]
- -h, --help¶
show this help message and exit
- --port <port>¶
Mgmt port (default: 42080)
