Start with the README for installation and product examples. These guides follow the CLI in this checkout. Run <command> --help for all flags and the authorization requirements of your installed version.
| Task | Guide |
|---|---|
| Run ClickHouse and Postgres locally | Local development |
| Create, query, scale, back up, and remove ClickHouse in Cloud | Cloud services |
| Connect to and operate ClickHouse Managed Postgres | ClickHouse Managed Postgres |
| Load object storage or replicate Postgres, then verify ingestion | ClickPipes |
| Create and safely replace a ClickStack dashboard | ClickStack |
| Test an executable UDF locally, then deploy and update it in Cloud | User-defined functions |
- Cloud authentication and access: scopes, credential precedence, selectors, keys, roles, logout.
- SQL and Query API behavior: key binding, input formats, timeouts, repair, named endpoints.
- ClickPipe configuration: partial updates, mappings, source authentication, private connectivity.
- Automation and output contracts: JSON shapes, stderr, exit codes, asynchronous operations.
- Telemetry: recorded fields, notice, opt-out, local inspection.
- Contributing: build, checks, and where documentation belongs.
- CLI development: code layout, test selection, live suites, debugging.
- API library: Rust client and API-specific documentation.