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

  • Easy to use type annotations for CLI parameters

  • 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, description='Simple greeting example'):
    name = Option('-n', default='World', help='The person to say hello to')
    count: int = Option('-c', 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.2.1.tar.gz (133.5 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.2.1-py3-none-any.whl (159.9 kB view details)

Uploaded Python 3

File details

Details for the file cli_command_parser-2026.2.1.tar.gz.

File metadata

  • Download URL: cli_command_parser-2026.2.1.tar.gz
  • Upload date:
  • Size: 133.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for cli_command_parser-2026.2.1.tar.gz
Algorithm Hash digest
SHA256 8770878c795709372a007a876a8f38d02caecda3cf88aa1e6f1ecaf52b6f38ec
MD5 55ac7e01eb02cd604e531d1da6235c2b
BLAKE2b-256 5b74f04892f1cf5c45a315ece69fad143635ee73f7e23d22d95ce15e6cf4c9c7

See more details on using hashes here.

File details

Details for the file cli_command_parser-2026.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for cli_command_parser-2026.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 45488b1b3bd1a9ee8b7133746f1ccd600aaa7e7407c4f7e727659bbf4bc8bd87
MD5 da3de27978b247de29772011e4283e0d
BLAKE2b-256 3e5ffd51119ad977ee27050bee4ac846df0488d4fa41caaecc917930fab47f09

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