Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
run_and_exit
✓ from pydantic_cli import run_and_exit
✗ from pydantic_cli.app import run_and_exit
run_and_exit was moved to top-level package in v10
AppConfig
✓ from pydantic_cli import AppConfig
✗ from pydantic_cli.config import AppConfig
AppConfig is now exported from pydantic_cli
Basic example: define a Pydantic model as CLI arguments and a runner function.
import sys
from pydantic import BaseModel
from pydantic_cli import run_and_exit
class Options(BaseModel):
name: str
count: int = 1
def runner(opts: Options) -> None:
for _ in range(opts.count):
print(f'Hello {opts.name}')
if __name__ == '__main__':
run_and_exit(Options, runner, description='A simple greeting app')
pydantic --version
Errors
Common errors & fixes
ModuleNotFoundError: No module named 'pydantic_cli'
Library not installed or installed with different capitalization.
fixRun 'pip install pydantic-cli' (hyphen, not underscore).
AttributeError: module 'pydantic_cli' has no attribute 'run_and_exit'
Using pydantic-cli v9 or earlier where the function was named differently or in a submodule.
fixUpgrade to v10: 'pip install -U pydantic-cli'. For v9, use 'from pydantic_cli.app import CLI'.
pydantic.errors.PydanticUserError: A custom validator must be a classmethod
Using pydantic v2 validators incorrectly; pydantic-cli v10 expects pydantic v2 model validation.
fixEnsure validators use @field_validator decorator from pydantic v2.
Upgrade
Version history
10.0.0latest on PyPI · released Oct 16, 2025
Audit
Dependencies
pydanticrequiredCore dependency; pydantic-cli 10.x requires pydantic v2