Skip to content

Getting Started: top-level commands and global flags are omitted from the walkthrough #68

Description

@trevor-vaughan

Summary

complyctl --help exposes a completion subcommand and global flags -d/--debug and
-w/--workspace that the getting-started never mentions. The page reads as the command list
while silently omitting part of the surface.

Affected

  • Page: content/docs/getting-started/_index.md
  • Reference: complyctl --help

Detail

complyctl --help ships completion, plus global flags -d/--debug and -w/--workspace,
none of which the page mentions. These are discoverable and mostly cobra built-ins, so this
is minor — but a reader treating the page as the canonical command list will not learn they
exist.

Suggested fix

Mention the global flags (-w/--workspace, -d/--debug) near the workspace and
troubleshooting material, and note completion where shell setup is discussed. A short
"full command reference: see complyctl --help" pointer would also cover this. (See the
related issue on the undocumented COMPLYTIME_* environment variables.)


Related: #63

Issue created with the help of Claude Opus 4.6

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Fields

    Priority

    Low

    Effort

    None yet

    Projects

    Status
    Ready 🚀

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions