ClickHouse / ClickHouse/clickhousectl
Track verified help-polish findings for v0.5.0
- Dominant language
- Rust
- Stars
- 74
- Forks
- 5
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 196
Description
## Validated scope and current-PR plan — 2026-09-11
This section records the QA review and the current decision to finalize existing PRs without opening new PRs. It supersedes the proposed routing/fix suggestions in the original report below; the original observations are retained. Central plan: #757.
### Disposition
Deferred from this existing-PR finalization pass. Keep the issue open; no new PR is requested now. This is not a resolution, a severity downgrade, or a waiver of release acceptance.
### Validation and corrections
Do not fold beta casing into #791: that PR removes an obsolete Prometheus beta label after graduation. Casing elsewhere is unrelated. GB for streaming and GiB for CDC match distinct published schemas, so normalization could make help wrong. Full-replacement “Replace” wording is useful and accurate. Prefer removing HTTP jargon while preserving replacement semantics. File/stdin placeholders and clearly overlong abouts are valid polish. A hidden release --url is still accepted; README visibility is documentation policy, not a broken command.
---
## Original QA report
Found in the 2026-09-11 QA sweep of the combined PR stack at [`d2c37f81`](https://github.com/ClickHouse/clickhousectl/commit/d2c37f814fff53fe68d636e34103e2d0550bf84d), top PR #823, installed release build (package version still 0.4.2). Reproduced behaviour only; no implementation included.
Severity: low; from a programmatic audit of all 239 help screens (shared-flag text is byte-identical everywhere; no `long_about`; all CONTEXT blocks ≤ 8 lines — those pass).
- `(Beta)` on `cloud udf`, `org quota`, `org balance`; `(beta)` on `cloud postgres`, `clickpipe schema-discover`.
- `clickpipe scale --memory-gb`: "Memory **GB** per replica (0.5-8…)"; `clickpipe cdc-scaling update --memory-gb`: "Memory **GiB** per replica (4-128…)".
- One concept, "JSON body from file or `-` for stdin", five placeholders: `` (udf create/version create), `` (backup bucket), `` (org role, all six clickstack — 12 screens), `` (clickpipe update), `` (postgres config patch, scaling-schedule set — both accept stdin per their prose). Standardise on ``.
- All six `clickstack … update` abouts read "Replace a ClickStack X" (accurate: full PUT) while every other domain's `update` is "Update X" (partial PATCH). The sentence "This is a full PUT replacement; include every required and desired field." is repeated verbatim on 5–6 leaves and absent from the `clickstack` parent. Per AGENTS.md, state it once on the parent.
- README "Debugging" documents `clickhousectl cloud --url …` as a normal feature; the flag is `hide = true` outside debug builds, so `cloud --help` on a release build never shows it. Un-hide or mark it internal in README.
- Abouts > 60 chars: `clickpipe create object-storage` (68), `reverse-private-endpoint` (71) and its `update` (69), `schema-discover object-storage` (75), `schema-discover pubsub` (67), `local client` (61), `local server configs` (61).
- `cloud --help` and `cloud auth login --help` restate the same credentials-file/read+write sentence.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the validated scope in this issue and central plan #757, then read AGENTS.md and the README Debugging section. Review the affected clickhousectl help entry points and the retained QA observations, but confirm a new scoped task with maintainers first: this issue currently requests no new PR and has no defined done state.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100