Quix CLI Commands Summary
This quick reference guide lists common use cases for the Quix CLI with the corresponding commands. Use this guide to quickly find and execute the commands you need while developing Quix data pipelines locally.
Core commands
| Use Case | Command |
|---|---|
Update application .env files from quix.yaml |
quix init --update |
Run applications with the variables from .env |
quix run |
| Update pipeline configuration | quix pipeline update |
| Bring pipeline up in Docker | quix pipeline up |
| Get a global status check of the CLI settings | quix status |
| Display the current status of the local pipeline | quix pipeline status |
| Push local changes to Git and sync with Quix Cloud | quix pipeline sync |
| Read messages from a topic in your pipeline | quix broker topics read |
| Write messages to a topic in your pipeline | quix broker topics write |
Initialization
| Use Case | Command |
|---|---|
| Initialize a new Quix project | quix init |
| Initialize with DevContainer support | quix init --devcontainer |
Initialize a project updating .env files from quix.yaml |
quix init --update |
Application Management
| Use Case | Command |
|---|---|
| Create a new application | quix app add |
| Edit the variables of an application | quix app edit |
| List applications in the project | quix app list |
| Add a variable to an application | quix app vars add |
| Edit the variables of an application | quix app vars edit |
Pipeline Management
| Use Case | Command |
|---|---|
| Update pipeline from current applications configurations | quix pipeline update |
| View pipeline graph | quix pipeline view |
| Bring pipeline up in Docker | quix pipeline up |
| Bring pipeline up in Docker and update the configuration | quix pipeline up --update |
| Bring pipeline down in Docker | quix pipeline down |
| Start a deployment in Docker | quix pipeline start |
| Stop a deployment in Docker | quix pipeline stop |
| Read the logs from the local pipeline | quix pipeline logs |
| Push local changes to Git and sync with Quix Cloud | quix pipeline sync |
Broker Management
| Use Case | Command |
|---|---|
| Start local pipeline broker | quix broker up |
| Stop local pipeline broker | quix broker down |
| List all the topics from your pipeline broker | quix broker topic list |
| Read the content of a topic from your pipeline broker | quix broker topic read |
| Read messages from a topic in your pipeline | quix broker topics read |
| Write messages to a topic in your pipeline | quix broker topics write |
SDK Broker Configuration
| Use Case | Command |
|---|---|
| Set SDK broker to custom local address | quix sdk broker set <broker-address> --enable |
| Set SDK broker to Quix Cloud | quix sdk broker cloud |
| Set SDK broker to default local configuration | quix sdk broker local |
Running Applications
| Use Case | Command |
|---|---|
Run with the variables from .env |
quix run |
Update the .env variables from the pipeline and run |
quix run --update |
| Run and stop deployed version of the application | quix run --stop |
| Run and intercept deployed version of the application | quix run --intercept |
Common Options
Quix CLI offers several common options that can be used across all commands:
| Option | Description |
|---|---|
-v, --verbose, --verbosity |
Displays detailed, verbose output, useful for troubleshooting. |
-h, -?, --help |
Shows help and usage information for the current command. |
Help Output Overview
When using the --help option with any command, you’ll see the following structure:
- Description: A short explanation of what the command does.
- Aliases: Lists any alternative names or shortcuts for the command.
- Usage: The command syntax, showing how to apply arguments and options.
- Commands (optional): If the command has subcommands, these will be listed here.
- Options: Displays all available flags and parameters that modify the command’s behavior.
- Documentation Link: A link to detailed documentation for further guidance.
This layout provides a quick, at-a-glance reference to help you efficiently run and customize the command.