Qala CLI,

A step by step guide to install the Qala CLI on your system, a command-line interface that will enable you to manage your Q-Flow configuration via terminal.

Documentation

The Qala CLI is a command-line interface that allows you to manage your Q-Flow configuration via terminal.

The Qala CLI is a powerful tool that enables you to interact with your Q-Flow configuration, manage your sources, topics, subscriptions, and events, and inspect and rotate secrets. Use it to automate your workflows, integrate with other tools, and manage your Q-Flow configuration with ease.

This guide will walk you through the steps to install the Qala CLI on your system.

Installation

This guide provides step-by-step instructions to install the Qala CLI app on Windows, Linux, and macOS.

After installation, you will validate the installation by running a simple command in the terminal.

Windows

• Download the Installer:
  • Go to the official Qala download page and download the latest .msi installer for your Windows version (x64 or arm64).
• Run the Installer:
  • Double-click the downloaded .msi file to start the installation.
  • Follow the installation wizard:
  • Accept the License Agreement.
  • Click "Install" and wait for the process to complete.
• Complete Installation:
  • Click "Finish" to complete the installation.
• Validation:
  • Open Command Prompt or PowerShell.
  • Run the following command:

  qala --help

  • If installed correctly, you should see the help text displaying all available commands and options.

Linux

• Install via npm:

  npm install -g @qala/qala-linux-cli

Alternative Method: Download and Extract the tar.gz File:

• Go to the official Qala download page and download the latest tar.gz file for your Linux distribution.
• Extract the tar.gz File:

tar -xvzf qala-version-linux.tar.gz

• Move the Executable:

sudo mv qala /usr/local/bin/

sudo chmod +x /usr/local/bin/qala

• Validation:

  qala --help

• If installed correctly, you should see the help text displaying all available commands and options.

macOS

• Install via npm:

  npm install -g @qala/qala-macos-cli

Alternative Method: Download and Extract the tar.gz File:

• Go to the official Qala download page and download the latest tar.gz file for macOS.
• Extract the tar.gz File:

tar -xvzf qala-version-macos.tar.gz

• Move the Executable:

sudo mv qala /usr/local/bin/

sudo chmod +x /usr/local/bin/qala

• Validation:

  qala --help

• If installed correctly, you should see the help text displaying all available commands and options.

Troubleshooting Tips

• Ensure the executable is in a directory that is part of your PATH environment variable.
• If the command is not found, restart your terminal or run source ~/.bashrc (or the relevant shell configuration file).
• On macOS, you may need to grant permission to run the application by going to System Preferences > Security & Privacy