Skip to content

Prefer specifying long-flags when invoking CLIs #264

@mroeschke

Description

@mroeschke

A lot of CLIs provide the option to specify some/most/all of their arguments using short or long flags (e.g. -v vs --verbose). I find that the long flags are more self-documenting and easier to uniquely grep for when searching through invocations in a project.

I suggest that long flags should be preferred when projects contain scripts (or related) that call CLIs or configuration files for CLIs for the above reasons. I don't believe there's a tool that could help us enforce this practice, but possibly an AI agent skill could help review for this practice if we adopt a long flag convention.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions