Interactive help in CLI · Issue #89377 · ClickHouse/ClickHouse · GitHub
Skip to content

Interactive help in CLI #89377

Description

@alexey-milovidov

Company or project name

ClickHouse

Use case

help works in many command-line interfaces, starting from the oldest and historical ones. So should it work in ClickHouse.

Describe the solution you'd like

Add help command to clickhouse-client/clickhouse-local.

Typing help word will search it among all our structured documentation and output the docs, formatted in the terminal from Markdown, with additional structured details (like default values, examples, etc).

If the word is not found or if it is ambiguous, it should list possible matches.

Describe alternatives you've considered

No response

Additional context

No response

Version info

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions