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.7.4.tar.gz (144.9 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.7.4-py3-none-any.whl (171.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cli_command_parser-2026.7.4.tar.gz
  • Upload date:
  • Size: 144.9 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.7.4.tar.gz
Algorithm Hash digest
SHA256 6050e8e4b18faacb9020a4279739e561da2a2a2e06a22f930a7f0cd99b55f206
MD5 d1fcce85930a5d429524f6741c36f074
BLAKE2b-256 4506f664557941c98eb1c54898ea46075d25f7e5f4e8839b6fa47f98640bf1b6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cli_command_parser-2026.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0c98651da44138a1b32a5306f54b08ad1e7366221d4160943ae3e5ef5f25f14d
MD5 7c11b0d9bc82a8abd3d3fe09cf3adfee
BLAKE2b-256 f5c517e78e696fecf33ccd7d8d40ffc610f54182a58afa2dcb9013b747bb018b

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