Quix Command Line Interface (CLI)

The Quix CLI is a free tool designed to help you create, debug, and run streaming pipelines locally using Docker and Quix Streams. It also serves as a companion app for managing and interacting with your Quix Cloud account. While Quix Cloud offers a robust frontend UI for a user-friendly experience, the CLI provides efficiency and flexibility, allowing you to streamline your workflow and take control from the command line.

Quix CLI streamlines your workflow by offering three core categories of functionality:

1. Local Commands: Develop and test your streaming pipelines locally. Use predefined samples or write custom code in Python with Quix Streams. The CLI enables you to run these pipelines in Docker containers for seamless testing and debugging. When ready, you can deploy and synchronize your local pipelines directly to Quix Cloud.

2. Cloud Commands: Manage your Quix Cloud account with precision and efficiency right from the command line. While the Quix Cloud UI offers a comprehensive interface, the CLI accelerates your workflow, making complex tasks more accessible.

3. Utility Commands: Handle essential tasks such as checking your status, updating the CLI, adjusting configurations, accessing interactive help, and managing contexts (i.e., defining the endpoint or environment the CLI connects to).

To get started with Quix CLI, explore our CLI Quickstart guide for a step-by-step tutorial.

For in-depth details on all features and commands, visit the Quix Documentation.

Installation of Quix CLI

Quix CLI can be installed on various operating systems using different methods. Below are the instructions for Linux, macOS, and Windows.

Script Installation

For macOS:

• Install the latest version:

  curl -fsSL https://github.com/quixio/quix-cli/raw/main/install.sh | bash

• Install a specific version:

  curl -fsSL https://github.com/quixio/quix-cli/raw/main/install.sh | bash -s -- -v={version}

For Linux:

• Install the latest version:

  curl -fsSL https://github.com/quixio/quix-cli/raw/main/install.sh | bash

• Install a specific version:

  curl -fsSL https://github.com/quixio/quix-cli/raw/main/install.sh | bash -s -- -v={version}

For Windows (PowerShell):

• Install the latest version:

  iwr https://github.com/quixio/quix-cli/raw/main/install.ps1 -useb | iex

• Install a specific version:

  $quixCliInstall = (iwr https://github.com/quixio/quix-cli/raw/main/install.ps1 -useb).Content; $version="{version}"; iex "$quixCliInstall"

Note

For version specification, replace {version} with the actual version number you intend to install (e.g., 1.2.3). Omitting the {version} parameter will install the latest available version of Quix CLI. Ensure that the directory where Quix CLI is installed is included in your system's PATH.

Installation using Release Binaries

1. Visit the latest release page and download the executable matching your OS/architecture.
2. Copy the executable to a location of your choice.
3. Add that location to your system's PATH.

Keeping Your CLI Up-to-Date

It's important to regularly update your Quix CLI to ensure you have access to the latest features, bug fixes, and improvements. You can do this easily using the quix update command, which installs the latest stable version by default.

You can also install specific versions or pre-releases if needed. For more details on the update process, including how to update to pre-release versions, visit the Quix CLI update command documentation.

Usage

To view a complete list of available commands, run:

quix --help

For an overview of all CLI commands, refer to the Commands Summary in the documentation.

Login

You can log in using one of two methods:

1. Interactive Login

   Run the following command to open your browser and complete the login:

   quix login

2. Login with PAT (Personal Access Token)

   Log in using your PAT token by running:

   quix login <patToken>

Get Started

After setting up your context and logging in, you're ready to explore the capabilities of your Quix organization. Begin by visiting the Quix CLI Documentation for a comprehensive overview of all features, commands, and essential guides. To help you get started, we recommend the following resources:

Quickstart and Essentials

• Quickstart Guide: Follow these step-by-step instructions to quickly set up and start using the Quix CLI.

• Commands Summary: Use this quick reference guide to find and execute the most common Quix CLI commands for developing and managing your data pipelines. This guide is essential for efficiently navigating the CLI during your initial setup and beyond.

Local Development

• Local Development: Discover how to create, run, and debug streaming pipelines locally with the Quix CLI.

• Local Secrets Management: Learn to securely manage secrets during local development to ensure safe and effective pipeline management.

YAML Descriptors

• Pipeline YAML Descriptor: Get detailed guidance on defining pipelines using the quix.yaml file.

• Application YAML Descriptor: Instructions for configuring applications with the app.yaml descriptor.

Using dedicated Quix clusters

The CLI defaults to using the Serverless platform as its context: https://portal-api.platform.quix.io/

For Dedicated or BYOC Quix clusters, you can add your own context by running:

quix contexts add <name> <portalEndpoint>

Select it using the following command:

quix contexts use <name>

Need Help?

If you encounter any issues, please create an issue or ask for assistance in #quix-help in our Quix Community on Slack.

Community 👭

Join other software engineers in The Stream, an online community focused on data streaming. This is a space to share and gain knowledge.

🙌 Join our Slack community!

Stay in Touch 👋

Follow us on Twitter and LinkedIn to stay updated with our latest tutorials, community events, and more.

For any questions or feedback, feel free to contact us at support@quix.io.