Skip to main content

clickhouse-tool

A command-line client for querying and inspecting ClickHouse, over both the native protocol (port 9000) and HTTP (port 8123).

clickhouse-tool provides porcelain commands (logs, hosts, services) for browsing OTel-shaped log data, plus low-level verbs (query, list, lift, config) for direct inspection of any table. Output renders as a table, JSON, NDJSON, or the compact TOON format, with pinned typed exit codes for scripting.

Install

pip install clickhouse-tool[native]   # native protocol (port 9000)
pip install clickhouse-tool[http]     # HTTP protocol (port 8123)
pip install clickhouse-tool[all]      # both

Configuration

Copy config.example.toml to ./clickhouse-tool.toml or ~/.config/clickhouse-tool/config.toml and fill in a profile for your cluster. See that file for the full set of options.

Metadata

Release files for clickhouse-tool 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for clickhouse-tool 0.1.1
File Size Uploaded
clickhouse_tool-0.1.1.tar.gz 156.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for clickhouse-tool 0.1.1
File Interpreter ABI Platform
clickhouse_tool-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 207.9 kB

Release files / clickhouse_tool-0.1.1.tar.gz

Download URL clickhouse_tool-0.1.1.tar.gz
Size 156.8 kB
Tags Source
SHA-256 checksum
How to use checksums
64f34a7c5e511935909dfd6aa815b626dc5fa56711d75e2436cb82cacd38f11c
BLAKE2b-256 checksum
How to use checksums
688c4de48350d009592e794ba92f48a7f5d3784fdcec10afaa5c61c2f4a1a17b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.7

Release files / clickhouse_tool-0.1.1-py3-none-any.whl

Download URL clickhouse_tool-0.1.1-py3-none-any.whl
Size 51.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
97f1937418dd01aecdbe7ea7022076da054c5f03e838515f0bf47f214c3aef38
BLAKE2b-256 checksum
How to use checksums
cc361ebf8a64505c7eca561441847a5529f8288364417ad3c72910835930e9df
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.7

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page