Add 'doctor' and 'explain' commands (v3.11.0) - #4
Merged
Conversation
Two terminal-native features distilled from the (abandoned) web-console exploration — the genuinely useful parts, with no server/attack surface. - 'doctor': local, read-only health checks with ✓/!/✗ output and a non-zero exit on problems — required/optional toolchain, output dir + free disk, per-database backup freshness (age of the newest dump), newest-archive readability, and the jobs file. With --from/--to it also tests connectivity. Good as a cron pre-flight or CI gate. - 'explain [topic]': built-in, offline reference for what each command is for and when to use it (dump/restore/clone/stream/upgrade/fetch/batch/bot/ list/meta/clean/doctor + masking/retention), with key options and examples. Wired into dispatch, help, README, and bash/zsh/fish completions (also adds the previously-missing 'bot' completion). New modules src/71-explain.sh and src/73-doctor.sh; regenerated the bundled t-pgsql (build --check passes).
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
1 participant
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
Revives the previously closed #2, rebased onto v3.10.0 (no conflicts, bundle regenerated).
doctor: local, read-only health checks with ✓/!/✗ output and a non-zero exit on problems — required/optional toolchain, output dir + free disk, per-database backup freshness (age of the newest dump), newest-archive readability, and the jobs file. With--from/--toit also tests connectivity. Useful as a cron pre-flight or CI/monitoring gate.explain [topic]: built-in, offline reference for what each command is for and when to use it, with key options and examples.Wired into dispatch, help, README and bash/zsh/fish completions (also adds the previously-missing
botcompletion). Version bumped to 3.11.0 with a changelog entry.Testing
./build.sh --checkgreen;doctorandexplainsmoke-tested (doctor exits 0 on a healthy env, flags missingpvcorrectly)--compress-where/--from-stalestill present and parsed)