Command List

To see a list of all available commands and flags on your terminal, type and enter the commandhollaex

This is a full list of commands available. If you want to only see the core commands which are mandatorily necessary to operate an exchange, Please check the Operation section.

General Flags

All these flags will work with every command except for hollaex init

--path

  • Path of HollaEx Kit directory. If the --path flag doesn't get specified, the CLI automatically set the current directory of terminal as the Kit path by default.

--kube

  • Set the HollaEx CLI target server to remote Kuberenetes. Please reference the Kubernetes section to see more details.

--skip

  • Run script without verifying docker-compose setup.

hollaex import

Import downloaded settings file (.json) from the bitHolla dashboard.

--path

  • Path of your settings files.

hollaex setup

Setup the web client for the first launch. Learn more.

hollaex start

Start the exchange which already been setup. Learn more.

hollaex stop

Stop the existing exchange which already been running. Learn more.

hollaex restart

Restart the existing exchange. Learn more.

hollaex prod

Bring up the exchange to production stage.

Setting up the exchange domain and issuing SSL certificate are possible with this command.

hollaex build

Building the custom HollaEx core image again to includes user custom code like /mail or /plugins on HollaEx Kit.

The server should be restarted to apply the newly build Docker image.

hollaex upgrade

Upgrade the existing exchange to new version. Learn more.

--version

  • Version number of HollaEx Core to upgrade. You can always check the latest Core version number at here.

hollaex terminate

Terminate the existing exchange. THIS COMMAND WILL COMPLETELY REMOVE YOUR EXCHANGE ENVIRONMENT. Learn more.

hollaex web

Run web client for the exchange. Learn more.

--setup

  • Setup the web client for the first launch.

--start

  • Start the web client which already been setup.

--stop

  • Stop the web client.

--restart

  • Restart the web client.

--build

  • Rebuild the web client and upgrade.

--terminate

  • TERMINATE the web client.

hollaex toolbox

Toolbox with advanced features which could be helpful for your exchange operations. Learn more.

--backup

  • Run the full backup with pg_dumpall for the exchange PostgreSQL database.

--flush_redis

  • Run the full flush of Redis stored data. It could be helpful in certain situation If the exchange doesn't work properly.

--upgrade_api_only

  • Do zero-downtime rolling upgrade for API containers on Kubernetes.

--add_coin

  • Add new currency on exchange. Take a look at our customization page to learn more.

--remove_coin

  • Remove existing currency from exchange.

--add_trading_pair

--remove_trading_pair

  • Remove existing trading pair from exchange.

--issue_ssl

  • Issue SSL certificate on local Nginx by using Let's Encrypt.

--renew_ssl

  • Renew SSL certificate on local Nginx by using Let's Encrypt.

--update_registry_secret

  • Update the existing Docker registry secret at the Kubernetes Cluster.

    • Toolbox command only for users who running exchange at Kubernetes.

--set_activation_code

  • Update the activation code for the exchange to a new one.

    • Could be useful to switch activation code from trial to non-trial one.

--set_config

This command would completely override the existing user database based on the settings files user got at HollaEx Kit. Do not run it without full understanding of this command.

  • Update (override) the database constants based on user's settings files (configmap and secret files at /settings directory of HollaEx Kit)

--connect_database

  • Open a direct shell connection to the exchange PostgreSQL database by using psql.

    • psql should be installed first at user's computer before running this command.

--connect_redis

  • Open a direct shell connection to the exchange Redis by using redis-cli.

    • redis-cli should be installed first at user's computer before running this command.

--connect_influxdb

  • Open a direct shell connection to the exchange InfluxDB by using influx-client.

    • influx-client should be installed first at user's computer before running this command.

hollaex status

Show the exchange server status.

hollaex logs

Show overview of logs from the exchange server.

--target

  • Specifying a target container.

    • Supported targets: api, stream, engine, db, redis, influxdb

--line

  • Specifying last line(s) to print out.

    • 20 by default (Printing last 20 lines of logs).

--export <PATH>

  • Exporting the logs into a single file.

  • The path to save logs file should be passed with the --export flag.

hollaex version

Print out current installed version of HollaEx CLI.