Skip to content

apps library

Overview

Retrieve all library items

Aliases: library, lib

Usage:

quix apps library [options]

Options:

  • -o, --output <json|table>: Output type of the retrieved data
  • --language <language>: Filter items by language
  • --tags <tags>: Filter items by tag(s)
  • -s, --search <search>: Search for this string within the library item fields

Sample Usage

Listing All Library Items

To view all available apps in the library:

$ quix app lib

Sample output:

| Id                   | Name                 | Description             | Tags              |
| -------------------- | -------------------- | ----------------------- | ----------------- |
| kafka-connect-source | Kafka Connect Source | Install a Kafka Connect | Advanced, Source, |
|                      |                      | source connector in the | Connectors, Kafka |
|                      |                      | Quix platform           |                   |

Searching the Library

To search for items containing the term dashb, run:

$ quix app lib -s dashb

Sample output:

| Id        | Name                | Description                            | Tags                              |
| --------- | ------------------- | -------------------------------------- | --------------------------------- |
| streamlit | Streamlit dashboard | Run a Streamlit real-time dashboard    | Medium, QuixStreams, Destination, |
|           |                     | that displays data from a Kafka topic. | Streamlit                         |

Tip

Use the search option to quickly find relevant items by name or description.

Filtering by Tags

To filter library items by tag, such as Easy:

$ quix app lib --tags Easy

Sample output:

| Id                      | Name            | Description              | Tags                                    |
| ----------------------- | --------------- | ------------------------ | --------------------------------------- |
| nodejs-starter-template | Sample template | A template for Quix Code | Easy, Basic templates, Samples, Node.js |
|                         |                 | applications             |                                         |

Create a New App

To create a new app from a library item, run:

quix app add [library-item-id]