An open API service indexing awesome lists of open source software.

https://github.com/bakdata/quick-cli

Command line interface for Quick
https://github.com/bakdata/quick-cli

Last synced: 12 months ago
JSON representation

Command line interface for Quick

Awesome Lists containing this project

README

          

# Quick CLI

![Tests](https://github.com/bakdata/quick-cli/workflows/Test%20quick-cli/badge.svg)
![Code Quality](https://github.com/bakdata/quick-cli/workflows/Code%20Quality/badge.svg)
[![PyPI Version](https://img.shields.io/pypi/v/quick-cli?color=blue&label=PyPi%20Version)](https://pypi.org/project/quick-cli/)

> [!WARNING]
> Quick's CLI is deprecated and no longer actively maintained.
> Visit our [user guide](https://bakdata.github.io/quick/0.8/user/) for more information.

The Quick CLI lets you manage your Quick instance.
For more information on how to work with it, see our [user guide](https://bakdata.github.io/quick/dev/user/).

## Set up

The CLI is a Python project and you can install via pip:

```shell
pip install quick-cli
```

The first step after installing the CLI is creating a new context.
Our [user guide](https://bakdata.github.io/quick/dev/user/getting-started/setup-cli/) provides further information.

## Reference

There is a [list of all commands](https://bakdata.github.io/quick/dev/user/reference/cli-commands/) as a reference.
Additionally, you can run all commands with `-h` or `--help` to display a help message.

## Contributing

The [CLI's developer guide](https://bakdata.github.io/quick/dev/developer/cli/) provides more information on how to setup the project and the project's layout.
For general information, check out out the [contributing guide](https://bakdata.github.io/quick/dev/developer/contributing/).