CLI Tools with argparse and click

Up to this point, our programs have typically relied on hardcoded values or interactive input() prompts to receive user data. While input() is convenient for small, exploratory scripts, it limits automation because it requires a human to be present at runtime. Professional tools such as git, pip, and docker avoid this constraint by accepting instructions as command-line arguments when the program starts. This design allows them to run unattended, integrate into shell pipelines, and behave predictably in automated environments.

In this lesson, we will learn how to build command-line interfaces (CLIs) in Python that accept positional arguments and named options, generate help text automatically, and validate inputs before the main application logic runs.

The standard library approach: argparse

Python provides a standard library module named argparse for building robust command-line interfaces. Rather than manually inspecting sys.argv, which quickly becomes error-prone as the number of options grows, argparse allows us to declaratively define the arguments our program expects. The module automatically parses input, generates help messages (via -h or --help), and reports clear errors when invalid or missing arguments are supplied.

The typical workflow involves creating an ArgumentParser instance, registering expected arguments, and then invoking parse_args() to interpret the command-line input. Arguments fall into two primary categories:

• Positional arguments: Which are required and interpreted based on their order.

• Optional arguments: Commonly referred to as flags, which usually begin with one or two dashes (for example, --verbose) and may modify behavior without being strictly required.

With this structure in place, the program can validate user input before any core logic executes, ensuring predictable and professional behavior.

Right now, we have a file named README.md, which has the following content in it:

Run this command in the ... ...