Skip to content

Clarify local server lifecycle help - #520

Open
sdairs wants to merge 2 commits into
issue-467-client-project-scope-errorsfrom
issue-478-local-lifecycle-help
Open

Clarify local server lifecycle help#520
sdairs wants to merge 2 commits into
issue-467-client-project-scope-errorsfrom
issue-478-local-lifecycle-help

Conversation

@sdairs

@sdairs sdairs commented Aug 24, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • document exact canonical-CWD project scope and the inherited omitted-name policies for local ClickHouse server teardown
  • give coding agents a named start, stop, and remove workflow, including generated-name retention and project cleanup via server stop-all
  • contrast global ClickHouse version removal with project-local server-data removal in the README
  • pin the rendered lifecycle help for scope, examples, selection behavior, and cleanup guidance

Closes #478

Tests

  • clickhousectl local server --help
  • clickhousectl local server start --help
  • clickhousectl local server stop --help
  • clickhousectl local server remove --help
  • clickhousectl local server stop-all --help
  • cargo fmt --all --check
  • cargo test -p clickhousectl (639 unit tests plus all integration suites)
  • cargo clippy -p clickhousectl --all-targets -- -D warnings

Stack

@sdairs sdairs changed the title issue 478 local lifecycle help Clarify local server lifecycle help Aug 24, 2026
@sdairs
sdairs force-pushed the issue-478-local-lifecycle-help branch from 8eabc0c to f168202 Compare August 25, 2026 12:11
@sdairs

sdairs commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator Author

Addressed in c764b48.

  • Removed the top-level agent-help sentence that restated the stop-all descriptor, while preserving the non-obvious lifecycle and omitted-name guidance.
  • Removed the generated-name operational reminder from the README and updated the directly affected help assertion.
  • Verified with cargo test -p clickhousectl local::cli::tests, cargo fmt --all --check, cargo check -p clickhousectl, and cargo clippy -p clickhousectl --all-targets -- -D warnings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify local server lifecycle help: CWD scope, omitted-name behavior, and agent workflow

1 participant