Skip to main content

CLI Command Parser

Project description

downloads py_version coverage_badge build_status Ruff OpenSSF Best Practices

CLI Command Parser is a class-based CLI argument parser that defines parameters with descriptors. It provides the tools to quickly and easily get started with basic CLIs, and it scales well to support even very large and complex CLIs while remaining readable and easy to maintain.

Some of the primary goals and key features of this project:
  • Minimal boilerplate code is necessary to define CLI parameters and access their parsed values

  • Typing support for CLI parameters that can be validated via type checkers

  • Subcommands can inherit common parameters so they don’t need to be repeated

  • Easy to handle common initialization tasks for all actions / subcommands once

Example Program

from cli_command_parser import Command, Option, main

class Hello(Command):
    """Simple greeting example"""

    name = Option('-n', default='World', help='The person to say hello to')
    count = Option('-c', type=int, default=1, help='Number of times to repeat the message')

    def main(self):
        for _ in range(self.count):
            print(f'Hello {self.name}!')

if __name__ == '__main__':
    main()
$ hello_world.py --name Bob -c 3
Hello Bob!
Hello Bob!
Hello Bob!

$ hello_world.py -h
usage: hello_world.py [--name NAME] [--count COUNT] [--help]

Simple greeting example

Optional arguments:
  --name NAME, -n NAME        The person to say hello to (default: 'World')
  --count COUNT, -c COUNT     Number of times to repeat the message (default: 1)
  --help, -h                  Show this help message and exit

Installing CLI Command Parser

CLI Command Parser can be installed and updated via pip:

$ pip install -U cli-command-parser

There are no required dependencies. Support for formatting wide characters correctly in help text descriptions can be included by adding wcwidth to your project’s requirements, and/or by installing with optional dependencies:

$ pip install -U cli-command-parser[wcwidth]

Python Version Compatibility

Python versions 3.10 and above are currently supported. The last release of CLI Command Parser that supported 3.9 was 2025-09-27. Support for Python 3.9 officially ended on 2025-10-31.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cli_command_parser-2026.6.30.post1.tar.gz (145.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cli_command_parser-2026.6.30.post1-py3-none-any.whl (172.1 kB view details)

Uploaded Python 3

File details

Details for the file cli_command_parser-2026.6.30.post1.tar.gz.

File metadata

File hashes

Hashes for cli_command_parser-2026.6.30.post1.tar.gz
Algorithm Hash digest
SHA256 ce3e07600b5a49ba3c2c7f68598c830452b26efaad1832ff57a69e859cbb06ce
MD5 33d5b74f46578bf82a4d26647530f3ee
BLAKE2b-256 4b7e2d45667ca5dc100d487718703d57c3725adc2c879c25baadba2a1d84c94a

See more details on using hashes here.

File details

Details for the file cli_command_parser-2026.6.30.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for cli_command_parser-2026.6.30.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 96ecd896342251542a19ef20568bea2dd238afb9a775ac0788d2c892042952c1
MD5 5f85b44f3cb70d6f4c31a34470e8fc4f
BLAKE2b-256 392d70609ab59fa896f14c6a3d561e604acc2929f97cd1d8fad75a3c56e73c76

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page