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

NOTE: This tool is only supported for 64-bit Linux operating systems. It does not work on Windows or macOS.

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 installdir/bnhelper-tool.

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

  • Load the Bitnami console (Windows, Linux or macOS installers) or log in to the virtual machine console (OS X VM).

  • Run these commands to run the Bitnami Helper Tool:

      $ cd installdir
      $ sudo ./bnhelper-tool

Custom configurations

Add a custom action to the Bitnami Helper Tool

The Bitnami Helper Tool gets the list of available commands from the installdir/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 installdir/bnhelper-tool
Last modification March 24, 2021