docs: backfill CLI reference for reports and diagnostics commands - #210
Open
gregggreg wants to merge 1 commit into
Open
docs: backfill CLI reference for reports and diagnostics commands#210gregggreg wants to merge 1 commit into
gregggreg wants to merge 1 commit into
Conversation
gregggreg
force-pushed
the
docs/backfill-missing-docs
branch
from
August 9, 2026 09:10
fb36ce7 to
ffdeca0
Compare
Document the flags for status, logs, stats, report, busfactor, and doctor, none of which were covered in the CLI reference. Add the missing `report` and `busfactor` rows to the command table, and document the root `--version` and `--help` flags. Nightshift-Task: docs-backfill Nightshift-Ref: https://github.com/marcus/nightshift
gregggreg
force-pushed
the
docs/backfill-missing-docs
branch
from
August 9, 2026 09:17
ffdeca0 to
b40a220
Compare
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
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.
Gap
website/docs/cli-reference.mddocumentedrun,preview,task, andbudget, but the reports and diagnostics commands had no coverage at all — no flag tables, andreportandbusfactorwere missing from the command table entirely.Scope
One file, one commit, branched from
origin/main.status(2),logs(12),stats(2),report(9),busfactor(7), anddoctor(0 — noted explicitly as taking no flags), each with names, shorthands, defaults, and accepted values.nightshift reportandnightshift busfactorrows to the Core Commands table.--help/-hto the Global Flags table (cobra adds it to every command), and documented--version/-vseparately as a root-only flag.Verification
Flags().*registrations incmd/nightshift/commands/{status,logs,stats,report,busfactor,doctor}.go— nothing inferred.--version/-vand--help/-hconfirmed against a locally built binary.--versioncomes fromVersion: VersiononrootCmd, not a persistent flag, so it is documented as root-only rather than global —nightshift status --versionerrors withunknown flag: --version.busfactorpositional-vs---pathprecedence is documented frombusfactor.go(the flag wins; the positional is used only when the flag is empty; current directory otherwise).npm run buildinwebsite/succeeds.Identified but intentionally out of scope
--providerand--timeoutas global, but they are per-command:--provideris onbudget,budget snapshot, andbudget history;--timeoutis onrunanddaemon start. Neither is registered on the root command. Correcting this is a behavior-claim fix rather than a backfill, so it is left for a separate PR.config,init,install,uninstall, andcompletionare still absent from the Core Commands table.daemon,install, anduninstallhave no flag documentation.preview,task, andbudgetstill have example blocks without flag tables.Nightshift-Task: docs-backfill
Nightshift-Ref: https://github.com/marcus/nightshift