Learn About the Bitnami Helper Tool

The Bitnami Helper Tool is a command line tool designed for executing frequently run commands in Bitnami stacks. This tool is located in the installation directory of the stack at /opt/bitnami.

Run the Bitnami Helper Tool

The Bitnami Helper Tool is included in every Bitnami Stack released since October 18th 2019. In order to check whether your stack includes it or doesn’t, please check if it is present at /opt/bitnami/bnhelper-tool.

To run the Bitnami Helper Tool, follow the instructions below:

• Connect to the server through SSH.

• Run these commands to run the Bitnami Helper Tool:

    $ cd /opt/bitnami
    $ sudo ./bnhelper-tool
  

Custom configurations

Automatically run the tool on login

You can configure your server to run the Bitnami Helper Tool every time you access it. This way, you won’t need to run any command to start this tool and run the frequently run commands easily when log in to the server. Follow the steps below:

• Connect to the server through SSH.
• Create a .ssh/rc file in the HOME folder of the user with the following content:

sudo /opt/bitnami/bnhelper-tool

• Exit the console and access the server console again. The Bitnami Helper Tool should be run automatically.

Add a custom action to the Bitnami Helper Tool

The Bitnami Helper Tool gets the list of available commands from the /opt/bitnami/bnhelper/bnhelper.json file.

• Edit the file and add a custom action as shown below::

...
  },
  {
    "Title":       "Custom action title",
    "Cli":         "Custom action command",
    "Description": "Custom action description",
    "Success":     "Custom action success message",
    "Fail":        "Custom action fail message"
  },
...

• Run the Bitnami Helper Tool again:

    $ sudo /opt/bitnami/bnhelper-tool