Skip to content

CLI conventions

Christopher Wolf edited this page May 3, 2025 · 1 revision

ConnyConsole tries to follow common CLI conventions which are listed below:

  • Pattern command [subcommand] [options] [arguments]
  • Commands/Verbs
    • Always lowercase
    • Define action to do/process
    • e.g. set, config, get
  • Flags/Options
    • Always lowercase
    • Long-/Multi-character-flags prefixed w/double dashes (--)
      • e.g. --help, --global
    • Short-/Single-character-flags prefixed w/single dash (-)
      • e.g. -h, -g
  • Argument
    • Represents a value of a command or option
    • e.g. --file C:\Temp\file.txt (argument -> C:\Temp\file.txt)

Clone this wiki locally