Command List

HollaEx-CLI provides many commands that help you configure, run and manage your exchange. Go to our Operation page for information on how to operate the CLI.

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

General Flags

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

--path

  • Path of HollaEx-Ki directory. It reads the values automatically from current directory by default.

--kube

  • Set the hollaex-cli target server to remote Kuberenetes. Setup your kubectl first before running this.

--skip

  • Run script without verifying docker-compose setup.

hollaex init

Pull HollaEx Kit for your new exchange.

hollaex import

Import downloaded settings files (configmap, secret)from the bitHolla dashboard.

--path

  • Path of your settings files.

hollaex setup

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

--reconfigure

  • Reconfigure basic settings such as Server domain or Activation Code.

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 upgrade

Upgrade the existing exchange to new version. Learn more.

--version

  • Version number of HOLLAEX Core to upgrade.

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.

--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.

hollaex version

Print out current installed version of hollaex-cli.