Skip to content

The Darling command line verbs have no single reference; a reader must know which README section holds each one #6413

Closed

Description

@erikdarlingdata

Claude posting for Erik Darling.

Who hits it: Darling admin and anyone scripting an install.

Where: Darling/README.md (verbs appear in at least 14 sections); Darling/PerformanceMonitor.Darling.Service/DarlingCliCommands.cs.

What is wrong or hard:
The service exe has many verbs: --test-connection, --validate-config, --check-settings, --diagnostics-bundle, --encrypt-password, --add-server, --enable-mcp, --disable-mcp, --enable-web, --disable-web, --configure-network, --configure-firewall, --export-viewer-config, --reset-password-key, --drop-xe-sessions, --set-collector-run-at, --enable-collector, --disable-collector, --backfill-rollups, --collapse-legacy-slices, --recompress-plan-dim, --add-alert-source, --print-sql. Each is explained where its feature is explained. There is no list that shows all of them with the one-line purpose, whether it needs elevation, whether the service must be stopped, and its exit codes. Exit codes are written out in long paragraphs (README lines 164-168), which is hard to scan.

Evidence:

  • Every verb above exists as a string in DarlingCliCommands.cs (checked with grep).
  • The exit code paragraphs for --check-settings, --enable-collector and --diagnostics-bundle differ slightly from each other, and each is a single long paragraph.

Proposed fix:
Add a "Command line reference" table to the Darling docs: verb, what it does, needs elevation (yes/no), service running (yes/no/either), exit codes, link. Generate or test the table against the verb list in the code so it cannot drift. Remove the long exit code paragraphs from the Quick Start.

On erikdarling.com? A searchable version on the website would help, but the table should live in the repo first.

Target: 3.12.

Activity

  1. added
    documentationImprovements or additions to documentation
    enhancementNew feature or request
    owner:pm-worker-helperLaptop helper session: click-test fixes. Other sessions leave these alone.
    3.12Planned for 3.12: install and admin friendliness, docs correctness and readability
    on Oct 22, 2026
  2. erikdarlingdata commented on Oct 22, 2026

    @erikdarlingdata
    OwnerAuthor

    Claude posting for Erik Darling.

    Correction after checking this issue against current dev:

    • The list in this issue is not the full set. The 23 verbs it names all exist, but the code has about 17 more, for example --help, --version, --harden-files, --print-mcp-token, --print-web-token, --print-viewer-connection, --set-collector-frequency, --set-collector-retention, and the alert-source verbs.
    • --help already prints a usage text (DarlingCliCommands.cs). Whether it covers every verb was not checked. There is still no reference table in the docs.

    The fix should generate the reference from the same source as --help, so the two cannot drift apart.

  3. added and removed
    owner:pm-worker-helperLaptop helper session: click-test fixes. Other sessions leave these alone.
    on Oct 22, 2026
  4. erikdarlingdata commented on Oct 24, 2026

    @erikdarlingdata
    OwnerAuthor

    Claude posting for Erik Darling. Fixed on dev by #6699 (f50b345). Ships in the next release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    3.12Planned for 3.12: install and admin friendliness, docs correctness and readabilitydocumentationImprovements or additions to documentationenhancementNew feature or requestowner:pm-worker-coordinatorLaptop coordinator session

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions