docs(admin-cli): document decommission-workers and worker-status#1180
Merged
nicoloboschi merged 2 commits intovectorize-io:mainfrom Apr 21, 2026
Conversation
PR vectorize-io#1165 added two new admin CLI commands (decommission-workers, worker-status) but admin-cli.md was not updated. Readers scanning the Commands section could only find the singular decommission-worker. Added dedicated sections for each new command following the existing style (Arguments/Options/Examples/When to Use). Pure docs, mirrors behavior documented in typer command help strings.
Mirror change from hindsight-docs/docs/developer/admin-cli.md so the docs skill reference stays in sync (matches the pattern set by vectorize-io#1137).
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
PR #1165 (feat(admin): add decommission-workers and worker-status CLI commands, merged 2026-04-20) added two new
hindsight-adminCLI commands tohindsight-api-slim/hindsight_api/admin/cli.pybuthindsight-docs/docs/developer/admin-cli.mdstill only documentsdecommission-worker(singular).Added dedicated sections for each new command, following the existing doc style (description / Options / Examples / When to Use):
decommission-workers(no WORKER_ID arg): releases ALL processing tasks across every worker, supports--schemaand--yesworker-status: prints all processing tasks grouped by worker with operation type, bank, runtime, and last-update-ago; supports--schemaBoth sections mirror the behavior documented in the
typer.Optiondefinitions and docstrings inadmin/cli.py(no new behavior invented). A:::warning Disruptivecallout ondecommission-workersnudges users toward the singular form when they know the worker ID.Mirrored the same content to
skills/hindsight-docs/references/developer/admin-cli.mdto keep the docs skill in sync (same dual-doc pattern as #1137).Test plan
run-db-migration/backup/restore/decommission-worker/decommission-workers/worker-statusall appear in the Commands section and have parallel structure