add-cli-command
Adds or changes a clickhousectl command, subcommand or flag, for local commands (`local ...`) or ClickHouse Cloud commands (`cloud ...`). Covers the clap definition, dispatch, handler, output, Cloud permissions, tests and help. Use when adding a command or flag, exposing a `clickhouse-cloud-api` method in the CLI, or changing what a command sends or prints.
Datos de origen
- Repositorio
- ClickHouse/clickhousectl
- Última actividad en el origen
- 14 de octubre de 2026 a las 18:02
- Idioma detectado de SKILL.md
- inglés
- Estrellas
- 80
- Forks
- 9
Opciones de instalación
De forma predeterminada está seleccionado el prompt que primero revisa el origen. Puedes cambiar a un comando directo o descargar una copia local.
Revisa los archivos de origen
Lee SKILL.md y los archivos complementarios que muestra SkillsMP antes de decidir si quieres instalarlo.
Explorador de archivos
3 archivosMostrando SKILL.md
SKILL.md
Instrucciones de origen · Vista previa de solo lectura- name
- add-cli-command
- description
- Adds or changes a clickhousectl command, subcommand or flag, for local commands (`local ...`) or ClickHouse Cloud commands (`cloud ...`). Covers the clap definition, dispatch, handler, output, Cloud permissions, tests and help. Use when adding a command or flag, exposing a `clickhouse-cloud-api` method in the CLI, or changing what a command sends or prints.
# Add a CLI command
Paths are relative to `crates/clickhousectl/`.
1. Follow the procedure for the kind of command:
- Local (`local ...`, runs on this machine): [references/local.md](references/local.md)
- Cloud (`cloud ...`, calls the Cloud API): [references/cloud.md](references/cloud.md)
2. Write help text with the `cli-help-text` skill (`.agents/skills/cli-help-text/SKILL.md`).
3. Finish with the steps below.
## Finish
- Add `Cli::try_parse_from` tests next to the clap definition for each new flag. Check the parsed value, the
default, whether it can repeat, and any conflicts with other flags.
- For each new source or test file, add an entry to both `scripts/classify-cloud-integration.py` and
`scripts/classify-install-integration.py`. CI fails on a file that is in neither.
- Update the relevant user guide or reference under `docs/` when users will see the change, following
`CONTRIBUTING.md`. Keep safety and behavioral details beside the affected task. Change the root `README.md`
only when its capability overview or representative examples need updating; do not add a flag catalog.
- Check documentation links/anchors and example commands against this branch's help and request definitions.
- Run the CLI commands from "Commands" in the root `AGENTS.md`. Both clippy configurations must pass.
Copy this checklist and tick it off as you go:
```
- [ ] Procedure steps (local.md or cloud.md)
- [ ] Help text follows the cli-help-text skill
- [ ] try_parse_from tests for new flags
- [ ] Both classifiers map new files
- [ ] Relevant guide/reference and any affected README example
- [ ] Documentation links and command examples checked
- [ ] fmt, both clippy configurations, tests
```
Ver en GitHub