Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/long2ice/chcli

A Terminal Client for ClickHouse with AutoCompletion and Syntax Highlighting.
https://github.com/long2ice/chcli

autocomplete cli clickhouse syntax-highlighting

Last synced: 2 days ago
JSON representation

A Terminal Client for ClickHouse with AutoCompletion and Syntax Highlighting.

Host: GitHub
URL: https://github.com/long2ice/chcli
Owner: long2ice
License: apache-2.0
Created: 2020-09-18T08:55:45.000Z (about 4 years ago)
Default Branch: dev
Last Pushed: 2020-10-16T09:51:27.000Z (almost 4 years ago)
Last Synced: 2024-09-18T09:11:51.207Z (17 days ago)
Topics: autocomplete, cli, clickhouse, syntax-highlighting
Language: Python
Homepage: https://github.com/long2ice/chcli
Size: 213 KB
Stars: 6
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # chcli

![pypi](https://img.shields.io/pypi/v/chcli.svg?style=flat)

![license](https://img.shields.io/github/license/long2ice/chcli)

![workflows](https://github.com/long2ice/chcli/workflows/pypi/badge.svg)

![workflows](https://github.com/long2ice/chcli/workflows/ci/badge.svg)

A Terminal Client for ClickHouse with AutoCompletion and Syntax Highlighting.

This project is inspired by [mycli](https://github.com/dbcli/mycli).

![screenshot](https://raw.githubusercontent.com/long2ice/chcli/dev/images/screenshot.png)

## Features

`chcli` is written using [prompt_toolkit](https://github.com/prompt-toolkit/python-prompt-toolkit) and [antlr4](https://pypi.org/project/antlr4-python3-runtime/) with [grammar](https://github.com/ClickHouse/ClickHouse/tree/master/utils/grammar).

- Auto-completion as you type for SQL keywords as well as tables, views and columns in the database.

- Syntax highlighting using `Pygments`.

- Pretty prints tabular data.

## Install

You can install just by pip.

```shell script

> pip install chcli

```

## Usage

```shell script

> chcli --help

Usage: chcli [OPTIONS]

  A Terminal Client for ClickHouse with AutoCompletion and Syntax

  Highlighting.

Options:

  -v, --version       Show the version and exit.

  -h, --host TEXT     ClickHouse server host.  [default: 127.0.0.1]

  -p, --port INTEGER  ClickHouse server port.  [default: 9000]

  -u, --user TEXT     ClickHouse server user.  [default: default]

  --password TEXT     ClickHouse server password.  [default: ]

  --help              Show this message and exit.

```

## License

This project is licensed under the [Apache-2.0](https://github.com/long2ice/chcli/blob/master/LICENSE) License.