[{"data":1,"prerenderedAt":2027},["ShallowReactive",2],{"page-\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools\u002F":3,"content-directory":1182},{"id":4,"title":5,"body":6,"date":1167,"description":1168,"difficulty":1169,"draft":1170,"extension":1171,"meta":1172,"navigation":235,"path":1173,"seo":1174,"stem":1175,"tags":1176,"updated":1167,"__hash__":1181},"content\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools\u002Findex.md","A Semantic Versioning Policy for CLI Tools",{"type":7,"value":8,"toc":1150},"minimark",[9,36,41,55,59,62,66,127,137,141,144,150,170,181,185,188,191,194,432,753,768,771,775,778,800,804,846,850,857,1054,1068,1072,1075,1079,1084,1087,1091,1094,1098,1105,1109,1112,1116,1146],[10,11,12,13,17,18,21,22,25,26,29,30,35],"p",{},"Semantic versioning says to bump the major version for incompatible API changes. For a library the API is obvious: the importable functions and classes. For a command-line tool it is not — and the ambiguity causes real breakage. Is renaming ",[14,15,16],"code",{},"--dir"," to ",[14,19,20],{},"--directory"," breaking? Rewording an error message? Adding a field to ",[14,23,24],{},"--json"," output? Changing an exit code from 1 to 2? Users who pin ",[14,27,28],{},"mytool>=2,\u003C3"," expect their scripts to keep working, and they can only rely on that if the project has decided — and written down — what its public interface is. This guide defines that interface for a CLI, gives a decision procedure for classifying changes, lays out a deprecation process that lets you evolve the tool without surprising anyone, and shows how to test that the policy is followed. It belongs to the ",[31,32,34],"a",{"href":33},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002F","managing CLI versioning and changelogs topic",".",[37,38,40],"h2",{"id":39},"prerequisites","Prerequisites",[42,43,44,48],"ul",{},[45,46,47],"li",{},"A CLI with users beyond its authors — especially users who run it from scripts, CI or cron.",[45,49,50,51,35],{},"A changelog, ideally structured as described in ",[31,52,54],{"href":53},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits\u002F","automating changelogs with conventional commits",[37,56,58],{"id":57},"what-is-a-clis-public-api","What is a CLI's public API?",[10,60,61],{},"Everything a script can observe and depend on. People read help text and messages; scripts parse output, check exit codes and pass flags. The versioning policy protects the scripts.",[63,64],"inline-diagram",{"name":65},"sv-public-api",[42,67,68,75,85,105,111,117],{},[45,69,70,74],{},[71,72,73],"strong",{},"Commands, subcommands, flags and arguments"," — names, meanings, defaults and whether they are required. Scripts invoke them.",[45,76,77,80,81,84],{},[71,78,79],{},"Exit codes"," — scripts branch on them. Changing \"no results\" from exit 1 to exit 0 silently breaks every ",[14,82,83],{},"if mytool search ...; then"," in the wild.",[45,86,87,90,91,93,94,93,97,100,101,35],{},[71,88,89],{},"Machine-readable output"," — ",[14,92,24],{},", ",[14,95,96],{},"--format csv",[14,98,99],{},"--porcelain",". Fields, their types and their meaning. See ",[31,102,104],{"href":103},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting\u002F","emitting JSON output for scripting",[45,106,107,110],{},[71,108,109],{},"Environment variables and config file keys"," the tool reads.",[45,112,113,116],{},[71,114,115],{},"Files the tool writes in documented locations",", where other tools read them.",[45,118,119,126],{},[71,120,121,122,125],{},"The ",[14,123,124],{},"requires-python"," range"," — dropping a Python version breaks installs on that version.",[10,128,129,130,133,134,136],{},"Explicitly ",[71,131,132],{},"not"," public: human-readable output formatting, wording of messages and help text, colours, progress bars, log lines, the order of lines in human output, and performance. Say so in your documentation. That statement is what frees you to improve the human experience in minor releases without being accused of breaking changes — and it is why tools like git provide separate ",[14,135,99],{}," formats for scripts.",[37,138,140],{"id":139},"the-recipe-classifying-a-change","The recipe: classifying a change",[63,142],{"name":143},"sv-decision",[10,145,146,147],{},"Ask one question: ",[71,148,149],{},"could a script that worked with the previous release fail, or silently behave differently, with this one?",[42,151,152,158,164],{},[45,153,154,157],{},[71,155,156],{},"Yes → major."," Removing or renaming a command or flag, changing a default in a way scripts observe, changing an exit code's meaning, removing or retyping a JSON field, stopping reading a config key, dropping a Python version.",[45,159,160,163],{},[71,161,162],{},"No, but something new is available → minor."," New commands, new flags, new JSON fields, new config keys, new supported Python versions, deprecation warnings.",[45,165,166,169],{},[71,167,168],{},"No, and behaviour now matches the documentation → patch."," Bug fixes, performance improvements, message rewording, dependency updates that change nothing observable.",[10,171,172,173,176,177,180],{},"Two grey areas deserve a written rule. ",[71,174,175],{},"Bug fixes that change behaviour scripts may rely on"," — for example an exit code that was wrong — are technically fixes; treat them as breaking if the old behaviour was plausible and documented nowhere as a bug, or at least call them out prominently in the changelog. ",[71,178,179],{},"New validation"," that rejects previously accepted input is breaking, even if the input was never meaningful; introduce it as a warning first.",[37,182,184],{"id":183},"the-recipe-deprecate-then-remove","The recipe: deprecate, then remove",[10,186,187],{},"Most breaking changes can be made gentle with a deprecation window: introduce the replacement, warn when the old form is used, and remove it only in the next major release.",[63,189],{"name":190},"sv-timeline",[10,192,193],{},"A small helper keeps deprecation warnings consistent, sends them to stderr (so they never break parsers of stdout), and shows each warning once per run:",[195,196,201],"pre",{"className":197,"code":198,"language":199,"meta":200,"style":200},"language-python shiki shiki-themes github-light github-dark","# src\u002Fmytool\u002Fdeprecation.py\nfrom __future__ import annotations\n\nimport os\nimport sys\n\n_shown: set[str] = set()\n\n\ndef deprecated(old: str, new: str, remove_in: str) -> None:\n    \"\"\"Warn once per run that `old` is deprecated in favour of `new`.\"\"\"\n    if old in _shown or os.environ.get(\"MYTOOL_NO_DEPRECATION_WARNINGS\"):\n        return\n    _shown.add(old)\n    print(f\"warning: {old} is deprecated and will be removed in {remove_in}; use {new} instead\",\n          file=sys.stderr)\n","python","",[14,202,203,212,230,237,246,254,259,280,285,290,324,331,358,364,370,420],{"__ignoreMap":200},[204,205,208],"span",{"class":206,"line":207},"line",1,[204,209,211],{"class":210},"sJ8bj","# src\u002Fmytool\u002Fdeprecation.py\n",[204,213,215,219,223,226],{"class":206,"line":214},2,[204,216,218],{"class":217},"szBVR","from",[204,220,222],{"class":221},"sj4cs"," __future__",[204,224,225],{"class":217}," import",[204,227,229],{"class":228},"sVt8B"," annotations\n",[204,231,233],{"class":206,"line":232},3,[204,234,236],{"emptyLinePlaceholder":235},true,"\n",[204,238,240,243],{"class":206,"line":239},4,[204,241,242],{"class":217},"import",[204,244,245],{"class":228}," os\n",[204,247,249,251],{"class":206,"line":248},5,[204,250,242],{"class":217},[204,252,253],{"class":228}," sys\n",[204,255,257],{"class":206,"line":256},6,[204,258,236],{"emptyLinePlaceholder":235},[204,260,262,265,268,271,274,277],{"class":206,"line":261},7,[204,263,264],{"class":228},"_shown: set[",[204,266,267],{"class":221},"str",[204,269,270],{"class":228},"] ",[204,272,273],{"class":217},"=",[204,275,276],{"class":221}," set",[204,278,279],{"class":228},"()\n",[204,281,283],{"class":206,"line":282},8,[204,284,236],{"emptyLinePlaceholder":235},[204,286,288],{"class":206,"line":287},9,[204,289,236],{"emptyLinePlaceholder":235},[204,291,293,296,300,303,305,308,310,313,315,318,321],{"class":206,"line":292},10,[204,294,295],{"class":217},"def",[204,297,299],{"class":298},"sScJk"," deprecated",[204,301,302],{"class":228},"(old: ",[204,304,267],{"class":221},[204,306,307],{"class":228},", new: ",[204,309,267],{"class":221},[204,311,312],{"class":228},", remove_in: ",[204,314,267],{"class":221},[204,316,317],{"class":228},") -> ",[204,319,320],{"class":221},"None",[204,322,323],{"class":228},":\n",[204,325,327],{"class":206,"line":326},11,[204,328,330],{"class":329},"sZZnC","    \"\"\"Warn once per run that `old` is deprecated in favour of `new`.\"\"\"\n",[204,332,334,337,340,343,346,349,352,355],{"class":206,"line":333},12,[204,335,336],{"class":217},"    if",[204,338,339],{"class":228}," old ",[204,341,342],{"class":217},"in",[204,344,345],{"class":228}," _shown ",[204,347,348],{"class":217},"or",[204,350,351],{"class":228}," os.environ.get(",[204,353,354],{"class":329},"\"MYTOOL_NO_DEPRECATION_WARNINGS\"",[204,356,357],{"class":228},"):\n",[204,359,361],{"class":206,"line":360},13,[204,362,363],{"class":217},"        return\n",[204,365,367],{"class":206,"line":366},14,[204,368,369],{"class":228},"    _shown.add(old)\n",[204,371,373,376,379,382,385,388,391,394,397,399,402,404,407,409,412,414,417],{"class":206,"line":372},15,[204,374,375],{"class":221},"    print",[204,377,378],{"class":228},"(",[204,380,381],{"class":217},"f",[204,383,384],{"class":329},"\"warning: ",[204,386,387],{"class":221},"{",[204,389,390],{"class":228},"old",[204,392,393],{"class":221},"}",[204,395,396],{"class":329}," is deprecated and will be removed in ",[204,398,387],{"class":221},[204,400,401],{"class":228},"remove_in",[204,403,393],{"class":221},[204,405,406],{"class":329},"; use ",[204,408,387],{"class":221},[204,410,411],{"class":228},"new",[204,413,393],{"class":221},[204,415,416],{"class":329}," instead\"",[204,418,419],{"class":228},",\n",[204,421,423,427,429],{"class":206,"line":422},16,[204,424,426],{"class":425},"s4XuR","          file",[204,428,273],{"class":217},[204,430,431],{"class":228},"sys.stderr)\n",[195,433,435],{"className":197,"code":434,"language":199,"meta":200,"style":200},"# src\u002Fmytool\u002Fcli.py\nfrom pathlib import Path\nfrom typing import Annotated\n\nimport typer\n\nfrom mytool.deprecation import deprecated\n\napp = typer.Typer()\n\n\n@app.callback()\ndef main() -> None:\n    \"\"\"Build tool.\"\"\"\n\n\n@app.command()\ndef build(\n    directory: Annotated[Path | None, typer.Option(\"--directory\", \"-C\")] = None,\n    old_dir: Annotated[Path | None, typer.Option(\"--dir\", hidden=True)] = None,\n) -> None:\n    \"\"\"Build the project in DIRECTORY (default: current directory).\"\"\"\n    if old_dir is not None:\n        deprecated(\"--dir\", \"--directory\", remove_in=\"3.0\")\n        directory = directory or old_dir\n    target = directory or Path.cwd()\n    typer.echo(f\"building {target}\", err=True)\n",[14,436,437,442,454,466,470,477,481,493,497,507,511,515,522,536,541,545,549,557,568,600,633,642,648,666,690,706,721],{"__ignoreMap":200},[204,438,439],{"class":206,"line":207},[204,440,441],{"class":210},"# src\u002Fmytool\u002Fcli.py\n",[204,443,444,446,449,451],{"class":206,"line":214},[204,445,218],{"class":217},[204,447,448],{"class":228}," pathlib ",[204,450,242],{"class":217},[204,452,453],{"class":228}," Path\n",[204,455,456,458,461,463],{"class":206,"line":232},[204,457,218],{"class":217},[204,459,460],{"class":228}," typing ",[204,462,242],{"class":217},[204,464,465],{"class":228}," Annotated\n",[204,467,468],{"class":206,"line":239},[204,469,236],{"emptyLinePlaceholder":235},[204,471,472,474],{"class":206,"line":248},[204,473,242],{"class":217},[204,475,476],{"class":228}," typer\n",[204,478,479],{"class":206,"line":256},[204,480,236],{"emptyLinePlaceholder":235},[204,482,483,485,488,490],{"class":206,"line":261},[204,484,218],{"class":217},[204,486,487],{"class":228}," mytool.deprecation ",[204,489,242],{"class":217},[204,491,492],{"class":228}," deprecated\n",[204,494,495],{"class":206,"line":282},[204,496,236],{"emptyLinePlaceholder":235},[204,498,499,502,504],{"class":206,"line":287},[204,500,501],{"class":228},"app ",[204,503,273],{"class":217},[204,505,506],{"class":228}," typer.Typer()\n",[204,508,509],{"class":206,"line":292},[204,510,236],{"emptyLinePlaceholder":235},[204,512,513],{"class":206,"line":326},[204,514,236],{"emptyLinePlaceholder":235},[204,516,517,520],{"class":206,"line":333},[204,518,519],{"class":298},"@app.callback",[204,521,279],{"class":228},[204,523,524,526,529,532,534],{"class":206,"line":360},[204,525,295],{"class":217},[204,527,528],{"class":298}," main",[204,530,531],{"class":228},"() -> ",[204,533,320],{"class":221},[204,535,323],{"class":228},[204,537,538],{"class":206,"line":366},[204,539,540],{"class":329},"    \"\"\"Build tool.\"\"\"\n",[204,542,543],{"class":206,"line":372},[204,544,236],{"emptyLinePlaceholder":235},[204,546,547],{"class":206,"line":422},[204,548,236],{"emptyLinePlaceholder":235},[204,550,552,555],{"class":206,"line":551},17,[204,553,554],{"class":298},"@app.command",[204,556,279],{"class":228},[204,558,560,562,565],{"class":206,"line":559},18,[204,561,295],{"class":217},[204,563,564],{"class":298}," build",[204,566,567],{"class":228},"(\n",[204,569,571,574,577,580,583,586,588,591,594,596,598],{"class":206,"line":570},19,[204,572,573],{"class":228},"    directory: Annotated[Path ",[204,575,576],{"class":217},"|",[204,578,579],{"class":221}," None",[204,581,582],{"class":228},", typer.Option(",[204,584,585],{"class":329},"\"--directory\"",[204,587,93],{"class":228},[204,589,590],{"class":329},"\"-C\"",[204,592,593],{"class":228},")] ",[204,595,273],{"class":217},[204,597,579],{"class":221},[204,599,419],{"class":228},[204,601,603,606,608,610,612,615,617,620,622,625,627,629,631],{"class":206,"line":602},20,[204,604,605],{"class":228},"    old_dir: Annotated[Path ",[204,607,576],{"class":217},[204,609,579],{"class":221},[204,611,582],{"class":228},[204,613,614],{"class":329},"\"--dir\"",[204,616,93],{"class":228},[204,618,619],{"class":425},"hidden",[204,621,273],{"class":217},[204,623,624],{"class":221},"True",[204,626,593],{"class":228},[204,628,273],{"class":217},[204,630,579],{"class":221},[204,632,419],{"class":228},[204,634,636,638,640],{"class":206,"line":635},21,[204,637,317],{"class":228},[204,639,320],{"class":221},[204,641,323],{"class":228},[204,643,645],{"class":206,"line":644},22,[204,646,647],{"class":329},"    \"\"\"Build the project in DIRECTORY (default: current directory).\"\"\"\n",[204,649,651,653,656,659,662,664],{"class":206,"line":650},23,[204,652,336],{"class":217},[204,654,655],{"class":228}," old_dir ",[204,657,658],{"class":217},"is",[204,660,661],{"class":217}," not",[204,663,579],{"class":221},[204,665,323],{"class":228},[204,667,669,672,674,676,678,680,682,684,687],{"class":206,"line":668},24,[204,670,671],{"class":228},"        deprecated(",[204,673,614],{"class":329},[204,675,93],{"class":228},[204,677,585],{"class":329},[204,679,93],{"class":228},[204,681,401],{"class":425},[204,683,273],{"class":217},[204,685,686],{"class":329},"\"3.0\"",[204,688,689],{"class":228},")\n",[204,691,693,696,698,701,703],{"class":206,"line":692},25,[204,694,695],{"class":228},"        directory ",[204,697,273],{"class":217},[204,699,700],{"class":228}," directory ",[204,702,348],{"class":217},[204,704,705],{"class":228}," old_dir\n",[204,707,709,712,714,716,718],{"class":206,"line":708},26,[204,710,711],{"class":228},"    target ",[204,713,273],{"class":217},[204,715,700],{"class":228},[204,717,348],{"class":217},[204,719,720],{"class":228}," Path.cwd()\n",[204,722,724,727,729,732,734,737,739,742,744,747,749,751],{"class":206,"line":723},27,[204,725,726],{"class":228},"    typer.echo(",[204,728,381],{"class":217},[204,730,731],{"class":329},"\"building ",[204,733,387],{"class":221},[204,735,736],{"class":228},"target",[204,738,393],{"class":221},[204,740,741],{"class":329},"\"",[204,743,93],{"class":228},[204,745,746],{"class":425},"err",[204,748,273],{"class":217},[204,750,624],{"class":221},[204,752,689],{"class":228},[10,754,755,756,759,760,763,764,35],{},"The old flag is ",[14,757,758],{},"hidden=True",", so new users only learn the new name from ",[14,761,762],{},"--help",", while existing scripts keep working and see a warning they can act on. The mechanics of deprecating flags are covered in depth in ",[31,765,767],{"href":766},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags\u002F","versioning and deprecating CLI flags",[10,769,770],{},"How long should the window be? At least one minor release, and long enough that users who update monthly will see the warning — a few months is typical for internal tools, longer for widely used public ones. The removal itself goes in the next major release, listed under a \"Breaking changes\" heading in the changelog.",[37,772,774],{"id":773},"before-10","Before 1.0",[10,776,777],{},"SemVer treats 0.x versions as unstable: anything may change at any time. That is honest for a prototype and a problem for a tool people already depend on. Two workable conventions:",[42,779,780,794],{},[45,781,782,785,786,789,790,793],{},[71,783,784],{},"Treat the minor version as major while in 0.x."," ",[14,787,788],{},"0.5 → 0.6"," may break things; ",[14,791,792],{},"0.5.1 → 0.5.2"," may not. Poetry's caret operator and many users' expectations already work this way.",[45,795,796,799],{},[71,797,798],{},"Go to 1.0 as soon as others script against the tool."," The version number should describe your compatibility promise, and \"people depend on this in CI\" is exactly the moment a promise is needed.",[37,801,803],{"id":802},"ux-considerations","UX considerations",[42,805,806,812,818,824],{},[45,807,808,811],{},[71,809,810],{},"Write the policy down."," A short \"Compatibility\" section in the README — what is public, what is not, how long deprecations last — sets expectations and settles arguments.",[45,813,814,817],{},[71,815,816],{},"Make breaking changes discoverable."," Put them first in the release notes, under their own heading, with the migration step for each.",[45,819,820,823],{},[71,821,822],{},"Offer an escape hatch for warnings."," An environment variable to silence deprecation warnings helps users who cannot update their scripts immediately and are drowning in stderr noise in CI.",[45,825,826,833,834,837,838,841,842,35],{},[71,827,828,829,832],{},"Consider ",[14,830,831],{},"--version"," output stable."," Scripts parse ",[14,835,836],{},"mytool --version",". Keep its first line in a fixed format (",[14,839,840],{},"mytool 2.4.0",") and put build metadata on later lines, as described in ",[31,843,845],{"href":844},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata\u002F","exposing version info and build metadata",[37,847,849],{"id":848},"testing-the-behaviour","Testing the behaviour",[10,851,852,853,856],{},"A policy is only as good as its enforcement. The most effective enforcement is a set of ",[71,854,855],{},"contract tests"," pinning the public surfaces: they must keep passing across minor releases, and changing them is a deliberate, reviewed act that signals a major bump.",[195,858,860],{"className":197,"code":859,"language":199,"meta":200,"style":200},"# tests\u002Ftest_contract.py\n\"\"\"Public CLI contract. Changing these tests means a MAJOR release.\"\"\"\nimport json\n\nfrom typer.testing import CliRunner\n\nfrom mytool.cli import app\n\nrunner = CliRunner()\n\n\ndef test_deprecated_flag_still_works_and_warns(tmp_path):\n    result = runner.invoke(app, [\"build\", \"--dir\", str(tmp_path)])\n    assert result.exit_code == 0\n    assert \"--dir is deprecated\" in result.output\n\n\ndef test_deprecated_flag_hidden_from_help():\n    result = runner.invoke(app, [\"build\", \"--help\"])\n    assert \"--directory\" in result.output\n    assert \"--dir \" not in result.output\n",[14,861,862,867,872,879,883,895,899,911,915,925,929,933,943,967,981,994,998,1002,1012,1030,1041],{"__ignoreMap":200},[204,863,864],{"class":206,"line":207},[204,865,866],{"class":210},"# tests\u002Ftest_contract.py\n",[204,868,869],{"class":206,"line":214},[204,870,871],{"class":329},"\"\"\"Public CLI contract. Changing these tests means a MAJOR release.\"\"\"\n",[204,873,874,876],{"class":206,"line":232},[204,875,242],{"class":217},[204,877,878],{"class":228}," json\n",[204,880,881],{"class":206,"line":239},[204,882,236],{"emptyLinePlaceholder":235},[204,884,885,887,890,892],{"class":206,"line":248},[204,886,218],{"class":217},[204,888,889],{"class":228}," typer.testing ",[204,891,242],{"class":217},[204,893,894],{"class":228}," CliRunner\n",[204,896,897],{"class":206,"line":256},[204,898,236],{"emptyLinePlaceholder":235},[204,900,901,903,906,908],{"class":206,"line":261},[204,902,218],{"class":217},[204,904,905],{"class":228}," mytool.cli ",[204,907,242],{"class":217},[204,909,910],{"class":228}," app\n",[204,912,913],{"class":206,"line":282},[204,914,236],{"emptyLinePlaceholder":235},[204,916,917,920,922],{"class":206,"line":287},[204,918,919],{"class":228},"runner ",[204,921,273],{"class":217},[204,923,924],{"class":228}," CliRunner()\n",[204,926,927],{"class":206,"line":292},[204,928,236],{"emptyLinePlaceholder":235},[204,930,931],{"class":206,"line":326},[204,932,236],{"emptyLinePlaceholder":235},[204,934,935,937,940],{"class":206,"line":333},[204,936,295],{"class":217},[204,938,939],{"class":298}," test_deprecated_flag_still_works_and_warns",[204,941,942],{"class":228},"(tmp_path):\n",[204,944,945,948,950,953,956,958,960,962,964],{"class":206,"line":360},[204,946,947],{"class":228},"    result ",[204,949,273],{"class":217},[204,951,952],{"class":228}," runner.invoke(app, [",[204,954,955],{"class":329},"\"build\"",[204,957,93],{"class":228},[204,959,614],{"class":329},[204,961,93],{"class":228},[204,963,267],{"class":221},[204,965,966],{"class":228},"(tmp_path)])\n",[204,968,969,972,975,978],{"class":206,"line":366},[204,970,971],{"class":217},"    assert",[204,973,974],{"class":228}," result.exit_code ",[204,976,977],{"class":217},"==",[204,979,980],{"class":221}," 0\n",[204,982,983,985,988,991],{"class":206,"line":372},[204,984,971],{"class":217},[204,986,987],{"class":329}," \"--dir is deprecated\"",[204,989,990],{"class":217}," in",[204,992,993],{"class":228}," result.output\n",[204,995,996],{"class":206,"line":422},[204,997,236],{"emptyLinePlaceholder":235},[204,999,1000],{"class":206,"line":551},[204,1001,236],{"emptyLinePlaceholder":235},[204,1003,1004,1006,1009],{"class":206,"line":559},[204,1005,295],{"class":217},[204,1007,1008],{"class":298}," test_deprecated_flag_hidden_from_help",[204,1010,1011],{"class":228},"():\n",[204,1013,1014,1016,1018,1020,1022,1024,1027],{"class":206,"line":570},[204,1015,947],{"class":228},[204,1017,273],{"class":217},[204,1019,952],{"class":228},[204,1021,955],{"class":329},[204,1023,93],{"class":228},[204,1025,1026],{"class":329},"\"--help\"",[204,1028,1029],{"class":228},"])\n",[204,1031,1032,1034,1037,1039],{"class":206,"line":602},[204,1033,971],{"class":217},[204,1035,1036],{"class":329}," \"--directory\"",[204,1038,990],{"class":217},[204,1040,993],{"class":228},[204,1042,1043,1045,1048,1050,1052],{"class":206,"line":635},[204,1044,971],{"class":217},[204,1046,1047],{"class":329}," \"--dir \"",[204,1049,661],{"class":217},[204,1051,990],{"class":217},[204,1053,993],{"class":228},[10,1055,1056,1057,1059,1060,1063,1064,35],{},"Extend the same file with tests for exit codes on documented failure modes and for the exact key set of every ",[14,1058,24],{}," output. Keeping them in one clearly named file makes the review question obvious: if a pull request edits ",[14,1061,1062],{},"test_contract.py",", it is proposing a breaking change. For whole-output snapshots of machine-readable formats, see ",[31,1065,1067],{"href":1066},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output\u002F","snapshot testing CLI output",[37,1069,1071],{"id":1070},"conclusion","Conclusion",[10,1073,1074],{},"Semantic versioning works for command-line tools once you decide what the API is: commands and flags, exit codes, machine-readable output, config keys and environment variables — not the wording of human output. Classify each change by whether an existing script could break, deprecate before removing with warnings on stderr, go to 1.0 when people depend on you, and pin the contract in tests that make breaking changes impossible to make by accident.",[37,1076,1078],{"id":1077},"frequently-asked-questions","Frequently asked questions",[1080,1081,1083],"h3",{"id":1082},"is-adding-a-new-field-to-json-output-a-breaking-change","Is adding a new field to JSON output a breaking change?",[10,1085,1086],{},"No, provided you documented that consumers must ignore unknown fields — which you should. Removing, renaming or changing the type of a field is breaking.",[1080,1088,1090],{"id":1089},"what-about-changing-defaults","What about changing defaults?",[10,1092,1093],{},"If a script that omits the flag now behaves differently in a way it can observe, it is breaking. A new default for colour or verbosity usually is not; a new default output directory usually is.",[1080,1095,1097],{"id":1096},"should-i-use-calver-instead","Should I use CalVer instead?",[10,1099,1100,1101,1104],{},"Calendar versioning (",[14,1102,1103],{},"2026.9.0",") suits tools whose releases are driven by time rather than compatibility — data releases, or tools that promise to always support \"the current platform\". It tells users when, not whether it will break. For most CLIs that other scripts depend on, SemVer's compatibility signal is more useful.",[1080,1106,1108],{"id":1107},"how-do-i-communicate-a-major-release-to-users-who-install-with-pipx","How do I communicate a major release to users who install with pipx?",[10,1110,1111],{},"pipx and uv tool installs do not upgrade automatically, so users often skip notes. A gentle update notice in the tool itself — rate-limited, disabled in CI — that mentions breaking changes in the new major version is the most reliable channel.",[37,1113,1115],{"id":1114},"related","Related",[42,1117,1118,1124,1130,1135,1140],{},[45,1119,1120,1121],{},"Up: ",[31,1122,1123],{"href":33},"Managing CLI versioning and changelogs",[45,1125,1126],{},[31,1127,1129],{"href":1128},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fderiving-versions-from-git-tags-with-hatch-vcs\u002F","Deriving versions from git tags with hatch-vcs",[45,1131,1132],{},[31,1133,1134],{"href":53},"Automating changelogs with conventional commits",[45,1136,1137],{},[31,1138,1139],{"href":766},"Versioning and deprecating CLI flags",[45,1141,1142],{},[31,1143,1145],{"href":1144},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently\u002F","Naming commands and flags consistently",[1147,1148,1149],"style",{},"html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}html pre.shiki code .szBVR, html code.shiki .szBVR{--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html pre.shiki code .s4XuR, html code.shiki .s4XuR{--shiki-default:#E36209;--shiki-dark:#FFAB70}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":200,"searchDepth":214,"depth":214,"links":1151},[1152,1153,1154,1155,1156,1157,1158,1159,1160,1166],{"id":39,"depth":214,"text":40},{"id":57,"depth":214,"text":58},{"id":139,"depth":214,"text":140},{"id":183,"depth":214,"text":184},{"id":773,"depth":214,"text":774},{"id":802,"depth":214,"text":803},{"id":848,"depth":214,"text":849},{"id":1070,"depth":214,"text":1071},{"id":1077,"depth":214,"text":1078,"children":1161},[1162,1163,1164,1165],{"id":1082,"depth":232,"text":1083},{"id":1089,"depth":232,"text":1090},{"id":1096,"depth":232,"text":1097},{"id":1107,"depth":232,"text":1108},{"id":1114,"depth":214,"text":1115},"2026-09-18","Decide what a major, minor or patch release means for a Python CLI: the public surfaces scripts depend on, deprecation windows, pre-1.0 rules and a tested policy.","intermediate",false,"md",{},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools",{"title":5,"description":1168},"project-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools\u002Findex",[1177,1178,1179,1180],"versioning","semver","deprecation","compatibility","bqojbeYKPud0JqoWFeut5Bam4JrnPhkOJqITqHmue04",[1183,1186,1189,1192,1195,1198,1201,1204,1207,1210,1213,1216,1219,1222,1225,1228,1231,1234,1237,1240,1243,1246,1249,1252,1255,1258,1261,1264,1267,1270,1273,1276,1279,1282,1285,1288,1291,1294,1297,1300,1303,1306,1309,1312,1315,1318,1321,1324,1327,1330,1333,1336,1339,1342,1345,1348,1351,1354,1357,1360,1363,1366,1369,1372,1375,1378,1381,1384,1387,1390,1393,1396,1399,1402,1405,1408,1411,1414,1417,1420,1423,1426,1429,1432,1435,1438,1441,1444,1447,1450,1453,1456,1459,1462,1465,1468,1471,1474,1477,1480,1483,1486,1489,1492,1495,1498,1501,1504,1507,1510,1513,1516,1519,1522,1525,1528,1531,1534,1537,1540,1543,1546,1549,1552,1555,1558,1561,1564,1567,1570,1573,1576,1579,1582,1585,1588,1591,1594,1597,1600,1603,1606,1609,1612,1615,1618,1621,1624,1627,1630,1633,1636,1639,1642,1645,1648,1651,1654,1657,1660,1663,1666,1669,1672,1675,1678,1681,1684,1687,1690,1693,1696,1699,1702,1705,1708,1711,1714,1717,1720,1723,1726,1729,1732,1735,1738,1741,1744,1747,1750,1753,1756,1759,1762,1765,1768,1771,1774,1777,1780,1783,1786,1789,1792,1795,1798,1801,1804,1807,1810,1813,1816,1819,1822,1825,1828,1831,1834,1837,1840,1843,1846,1849,1852,1855,1858,1861,1864,1867,1870,1873,1876,1879,1882,1885,1888,1891,1894,1897,1898,1901,1904,1907,1910,1913,1916,1919,1922,1925,1928,1931,1934,1937,1940,1943,1946,1949,1952,1955,1958,1961,1964,1967,1970,1973,1976,1979,1982,1985,1988,1991,1994,1997,2000,2003,2006,2009,2012,2015,2018,2021,2024],{"path":1184,"title":1185},"\u002Fabout","About Python CLI Toolcraft",{"path":1187,"title":1188},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":1190,"title":1191},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":1193,"title":1194},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dates-and-durations-in-cli-arguments","Validating Dates and Durations in Python CLI Arguments",{"path":1196,"title":1197},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":1199,"title":1200},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":1202,"title":1203},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-urls-hosts-and-ports","Validating URLs, Hosts and Ports in Python CLI Arguments",{"path":1205,"title":1206},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":1208,"title":1209},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbrowsing-records-with-a-textual-datatable","Browsing Records with a Textual DataTable Picker",{"path":1211,"title":1212},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbuilding-your-first-textual-app","Building Your First Textual App for a Python CLI",{"path":1214,"title":1215},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fchoosing-between-a-cli-a-prompt-flow-and-a-tui","Choosing Between a CLI, a Prompt Flow and a TUI",{"path":1217,"title":1218},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":1220,"title":1221},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Frunning-background-work-in-textual-with-workers","Running Background Work in Textual with Workers",{"path":1223,"title":1224},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fstyling-textual-apps-with-tcss","Styling Textual Apps with TCSS",{"path":1226,"title":1227},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":1229,"title":1230},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fadding-examples-and-epilogs-to-help-output","Adding Examples and Epilogs to Help Output",{"path":1232,"title":1233},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fdocumenting-environment-variables-in-help","Documenting Environment Variables in CLI Help",{"path":1235,"title":1236},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fgenerating-man-pages-and-docs-from-a-cli","Generating Man Pages and Docs from a CLI",{"path":1238,"title":1239},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":1241,"title":1242},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Frich-formatted-help-with-rich-click","Rich-Formatted Help for Click CLIs with rich-click",{"path":1244,"title":1245},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":1247,"title":1248},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":1250,"title":1251},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":1253,"title":1254},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":1256,"title":1257},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Ffixing-unicode-and-encoding-errors-on-windows","Fixing Unicode and Encoding Errors on Windows in Python CLIs",{"path":1259,"title":1260},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fhandling-ansi-escape-codes-on-windows-consoles","Handling ANSI Escape Codes on Windows Consoles",{"path":1262,"title":1263},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":1265,"title":1266},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Frespecting-no-color-and-force-color","Respecting NO_COLOR and FORCE_COLOR in Python CLIs",{"path":1268,"title":1269},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fsupporting-dumb-terminals-and-screen-readers","Supporting Dumb Terminals and Screen Readers in a Python CLI",{"path":1271,"title":1272},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":1274,"title":1275},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fdesigning-an-exception-hierarchy-for-a-cli","Designing an Exception Hierarchy for a Python CLI",{"path":1277,"title":1278},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fdid-you-mean-suggestions-for-mistyped-input","Did You Mean…? Suggestions for Mistyped CLI Input",{"path":1280,"title":1281},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":1283,"title":1284},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":1286,"title":1287},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":1289,"title":1290},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Freporting-machine-readable-errors-in-json-mode","Reporting Machine-Readable Errors in JSON Mode",{"path":1292,"title":1293},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fwriting-crash-reports-users-can-send","Writing Crash Reports Users Can Send",{"path":1295,"title":1296},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":1298,"title":1299},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fdiscovering-project-config-files-by-walking-up-directories","Discovering Project Config Files by Walking Up Directories",{"path":1301,"title":1302},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":1304,"title":1305},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Floading-yaml-configs-safely-in-cli-apps","Loading YAML configs safely in CLI apps",{"path":1307,"title":1308},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":1310,"title":1311},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":1313,"title":1314},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fvalidating-config-files-with-json-schema","Validating Config Files with JSON Schema in a Python CLI",{"path":1316,"title":1317},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fwriting-a-config-init-and-edit-command","Writing a Config Init and Edit Command for a Python CLI",{"path":1319,"title":1320},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":1322,"title":1323},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fadding-progress-bars-and-spinners-to-python-clis","Progress Bars and Spinners for Python CLIs",{"path":1325,"title":1326},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":1328,"title":1329},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-tree-views-with-rich","Building Tree Views with Rich in a Python CLI",{"path":1331,"title":1332},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":1334,"title":1335},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":1337,"title":1338},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-markdown-and-syntax-highlighting-with-rich","Rendering Markdown and Syntax Highlighting with Rich",{"path":1340,"title":1341},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":1343,"title":1344},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":1346,"title":1347},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis\u002Fadding-a-format-flag-for-table-json-and-csv","Adding a Format Flag for Table, JSON and CSV Output",{"path":1349,"title":1350},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis\u002Fcustom-output-templates-with-a-format-string","Custom Output Templates with a Format String in Python CLIs",{"path":1352,"title":1353},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis\u002Fexporting-cli-results-to-files","Exporting CLI Results to Files from a Python CLI",{"path":1355,"title":1356},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis","Output Formats for Data-Heavy Python CLIs",{"path":1358,"title":1359},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis\u002Fselecting-fields-and-columns-from-cli-output","Selecting Fields and Columns from Python CLI Output",{"path":1361,"title":1362},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis\u002Fwriting-csv-and-tsv-output-correctly","Writing CSV and TSV Output Correctly from a Python CLI",{"path":1364,"title":1365},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fargcomplete-for-argparse-clis","Tab Completion for argparse CLIs with argcomplete",{"path":1367,"title":1368},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fdynamic-completion-values-from-apis-and-files","Dynamic Completion Values from APIs and Files",{"path":1370,"title":1371},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fenabling-tab-completion-in-click-and-typer","Enabling Tab Completion in Click and Typer",{"path":1373,"title":1374},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":1376,"title":1377},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Finstalling-shell-completion-for-bash-zsh-fish","Installing Shell Completion for bash, zsh, fish",{"path":1379,"title":1380},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages","Shipping Shell Completion Scripts with a Python CLI",{"path":1382,"title":1383},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":1385,"title":1386},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-trace-ids-and-context-to-cli-logs","Adding Trace IDs and Context to Python CLI Logs",{"path":1388,"title":1389},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":1391,"title":1392},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":1394,"title":1395},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Flogging-with-structlog-in-a-cli","Logging with structlog in a Python CLI",{"path":1397,"title":1398},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fseparating-logs-from-program-output","Separating Logs from Program Output in a Python CLI",{"path":1400,"title":1401},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":1403,"title":1404},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fwriting-rotating-log-files-from-a-cli","Writing Rotating Log Files from a Python CLI",{"path":1406,"title":1407},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":1409,"title":1410},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":1412,"title":1413},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":1415,"title":1416},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":1418,"title":1419},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fnull-delimited-input-and-xargs-compatibility","Null-Delimited Input and xargs Compatibility in Python CLIs",{"path":1421,"title":1422},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fprocessing-large-files-and-ndjson-streams","Processing Large Files and NDJSON Streams in Python CLIs",{"path":1424,"title":1425},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":1427,"title":1428},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fbuilding-an-api-client-cli-with-httpx","Building an API Client CLI with httpx",{"path":1430,"title":1431},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":1433,"title":1434},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":1436,"title":1437},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fmocking-http-in-cli-tests-with-respx","Mocking HTTP in Python CLI Tests with respx",{"path":1439,"title":1440},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":1442,"title":1443},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":1445,"title":1446},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fretries-and-backoff-for-cli-http-calls","Retries and Backoff for CLI HTTP Calls",{"path":1448,"title":1449},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fuploading-files-with-multipart-and-progress","Uploading Files with Multipart and Progress in a Python CLI",{"path":1451,"title":1452},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fcancelling-async-tasks-on-ctrl-c","Cancelling Async Tasks on Ctrl+C in Python CLIs",{"path":1454,"title":1455},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":1457,"title":1458},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":1460,"title":1461},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":1463,"title":1464},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":1466,"title":1467},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frunning-async-code-in-typer-and-click","Running Async Code in Typer and Click",{"path":1469,"title":1470},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fshowing-progress-for-concurrent-tasks","Showing Progress for Concurrent Tasks in a Python CLI",{"path":1472,"title":1473},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fstructured-concurrency-with-taskgroups-in-clis","Structured Concurrency with TaskGroups in Python CLIs",{"path":1475,"title":1476},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":1478,"title":1479},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":1481,"title":1482},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fhandling-file-permissions-and-umask-in-clis","Handling File Permissions and umask in Python CLIs",{"path":1484,"title":1485},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":1487,"title":1488},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":1490,"title":1491},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":1493,"title":1494},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwalking-directory-trees-with-ignore-rules","Walking Directory Trees with Ignore Rules in a Python CLI",{"path":1496,"title":1497},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":1499,"title":1500},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":1502,"title":1503},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis\u002Fcaching-http-responses-on-disk-in-a-cli","Caching HTTP Responses on Disk in a Python CLI",{"path":1505,"title":1506},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis","Local State and SQLite in Python CLIs",{"path":1508,"title":1509},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis\u002Fmigrating-a-cli-sqlite-schema","Migrating a CLI’s SQLite Schema Between Releases",{"path":1511,"title":1512},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis\u002Frecording-and-querying-cli-run-history","Recording and Querying CLI Run History in SQLite",{"path":1514,"title":1515},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis\u002Fstoring-cli-state-in-sqlite","Storing CLI State in SQLite with a Small Repository Class",{"path":1517,"title":1518},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fbuilding-a-watch-mode-with-watchfiles","Building a Watch Mode with watchfiles in Python",{"path":1520,"title":1521},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":1523,"title":1524},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhealth-checks-and-heartbeats-for-long-running-clis","Health Checks and Heartbeats for Long-Running CLIs",{"path":1526,"title":1527},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":1529,"title":1530},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Freloading-config-on-sighup","Reloading Configuration on SIGHUP in a Python CLI",{"path":1532,"title":1533},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Frunning-a-cli-as-a-systemd-service","Running a Python CLI as a systemd Service",{"path":1535,"title":1536},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Frunning-a-cli-on-a-schedule-with-cron-and-systemd","Running a Python CLI on a Schedule with cron and systemd",{"path":1538,"title":1539},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fsending-cli-logs-to-journald-and-syslog","Sending Python CLI Logs to journald and syslog",{"path":1541,"title":1542},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":1544,"title":1545},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":1547,"title":1548},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":1550,"title":1551},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":1553,"title":1554},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Flaunching-the-users-editor-from-a-cli","Launching the User’s Editor from a Python CLI",{"path":1556,"title":1557},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fpiping-between-subprocesses-in-python","Piping Between Subprocesses in Python Without a Shell",{"path":1559,"title":1560},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":1562,"title":1563},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fwrapping-git-and-other-tools-from-a-python-cli","Wrapping git and Other Tools from a Python CLI",{"path":1565,"title":1566},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":1568,"title":1569},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":1571,"title":1572},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Freading-secrets-from-env-and-files","Reading Secrets from Env Vars and Files in CLIs",{"path":1574,"title":1575},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fredacting-secrets-from-cli-output-and-logs","Redacting Secrets from CLI Output and Logs",{"path":1577,"title":1578},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Frefreshing-expired-tokens-automatically","Refreshing Expired Tokens Automatically in a Python CLI",{"path":1580,"title":1581},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":1583,"title":1584},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":1586,"title":1587},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fchecking-pypi-for-a-newer-version","Checking PyPI for a Newer Version of Your Python CLI",{"path":1589,"title":1590},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis","Update Checks, Upgrade Commands and Telemetry for Python CLIs",{"path":1592,"title":1593},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fopt-in-usage-telemetry-for-python-clis","Opt-In Usage Telemetry for Python CLIs Done Responsibly",{"path":1595,"title":1596},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fself-upgrading-a-cli-installed-with-pipx-or-uv","Self-Upgrading a Python CLI Installed with pipx or uv",{"path":1598,"title":1599},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fshowing-non-blocking-update-notices","Showing Non-Blocking Update Notices in a Python CLI",{"path":1601,"title":1602},"\u002F","Python CLI Toolcraft",{"path":1604,"title":1605},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo","Building a Python CLI with Cleo Command Classes",{"path":1607,"title":1608},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts","Building a Type-Hinted Python CLI with Cyclopts",{"path":1610,"title":1611},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks","Beyond Click and Typer: Alternative Python CLI Frameworks",{"path":1613,"title":1614},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fquick-clis-from-functions-with-python-fire","Quick CLIs from Functions with Python Fire",{"path":1616,"title":1617},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fusage-string-driven-clis-with-docopt-ng","Usage-String Driven Python CLIs with docopt-ng",{"path":1619,"title":1620},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Favoiding-import-time-side-effects","Avoiding Import-Time Side Effects in a Python CLI",{"path":1622,"title":1623},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fcaching-expensive-work-between-cli-runs","Caching Expensive Work Between Python CLI Runs",{"path":1625,"title":1626},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fguarding-startup-with-import-tests","Guarding CLI Startup with Import Tests",{"path":1628,"title":1629},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":1631,"title":1632},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":1634,"title":1635},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":1637,"title":1638},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":1640,"title":1641},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":1643,"title":1644},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":1646,"title":1647},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargument-groups-and-help-formatting-in-argparse","Argument Groups and Help Formatting in argparse",{"path":1649,"title":1650},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":1652,"title":1653},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":1655,"title":1656},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":1658,"title":1659},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Freading-arguments-from-files-with-fromfile-prefix-chars","Reading Arguments from Files with argparse’s fromfile_prefix_chars",{"path":1661,"title":1662},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":1664,"title":1665},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fadding-dry-run-and-confirmation-to-destructive-commands","Adding Dry-Run and Confirmation to Destructive Commands",{"path":1667,"title":1668},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fdesigning-idempotent-commands","Designing Idempotent Commands in a Python CLI",{"path":1670,"title":1671},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Ffollowing-posix-and-gnu-argument-conventions","Following POSIX and GNU Argument Conventions in Python",{"path":1673,"title":1674},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fglobal-options-vs-per-command-options","Global Options vs Per-Command Options in Python CLIs",{"path":1676,"title":1677},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":1679,"title":1680},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":1682,"title":1683},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fpositional-arguments-vs-options","Positional Arguments vs Options: Designing a CLI Signature",{"path":1685,"title":1686},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":1688,"title":1689},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":1691,"title":1692},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":1694,"title":1695},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":1697,"title":1698},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures","Isolating Plugin Failures in an Extensible Python CLI",{"path":1700,"title":1701},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli","Testing Plugins Against the Host CLI",{"path":1703,"title":1704},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":1706,"title":1707},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fwriting-a-plugin-for-an-existing-cli","Writing a Plugin for an Existing CLI",{"path":1709,"title":1710},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fbest-practices-for-python-cli-entry-points","Best practices for Python CLI entry points",{"path":1712,"title":1713},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":1715,"title":1716},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fhow-to-structure-a-large-python-cli-project","Structuring a Large Python CLI Project",{"path":1718,"title":1719},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":1721,"title":1722},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Foffering-a-python-api-alongside-your-cli","Offering a Python API Alongside Your CLI",{"path":1724,"title":1725},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically","Registering CLI Commands from Modules Automatically",{"path":1727,"title":1728},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":1730,"title":1731},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":1733,"title":1734},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fend-to-end-testing-an-installed-cli","End-to-End Testing an Installed Python CLI",{"path":1736,"title":1737},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":1739,"title":1740},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":1742,"title":1743},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmocking-filesystem-and-network-in-cli-tests","Mocking the Filesystem and Network in CLI Tests",{"path":1745,"title":1746},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":1748,"title":1749},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":1751,"title":1752},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":1754,"title":1755},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-commands-that-call-subprocesses","Testing Python CLI Commands That Call Subprocesses",{"path":1757,"title":1758},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":1760,"title":1761},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands","Transcript Tests for Python CLI Commands",{"path":1763,"title":1764},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-a-cli-with-subcommands-in-click","Building a CLI with subcommands in Click",{"path":1766,"title":1767},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":1769,"title":1770},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fchoices-and-enums-in-typer-and-click","Choices and Enums in Typer and Click Options",{"path":1772,"title":1773},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fclick-option-callbacks-and-eager-options","Click Option Callbacks and Eager Options Explained",{"path":1775,"title":1776},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fconverting-a-click-app-to-typer","Converting a Click App to Typer",{"path":1778,"title":1779},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":1781,"title":1782},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Frich-markup-and-help-panels-in-typer","Rich Markup and Help Panels in Typer",{"path":1784,"title":1785},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":1787,"title":1788},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":1790,"title":1791},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":1793,"title":1794},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":1796,"title":1797},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":1799,"title":1800},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fpublishing-a-cli-docker-image-from-ci","Publishing a Python CLI as a Docker Image from CI",{"path":1802,"title":1803},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fpublishing-to-pypi-with-trusted-publishing","Publishing a CLI to PyPI with Trusted Publishing",{"path":1805,"title":1806},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Frunning-cli-tests-on-windows-and-macos-runners","Running Python CLI Tests on Windows and macOS Runners",{"path":1808,"title":1809},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fsmoke-testing-the-built-wheel-in-ci","Smoke-Testing the Built Wheel of a Python CLI in CI",{"path":1811,"title":1812},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Ftesting-a-cli-across-python-versions-with-github-actions","Testing a CLI Across Python Versions in GitHub Actions",{"path":1814,"title":1815},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":1817,"title":1818},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":1820,"title":1821},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":1823,"title":1824},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":1826,"title":1827},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftemplate-variables-and-conditional-files","Template Variables and Conditional Files in CLI Templates",{"path":1829,"title":1830},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftesting-a-project-template-with-pytest","Testing a CLI Project Template with pytest",{"path":1832,"title":1833},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fupdating-generated-projects-with-copier-update","Updating Generated CLI Projects with copier update",{"path":1835,"title":1836},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":1838,"title":1839},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":1841,"title":1842},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fcode-signing-and-notarizing-cli-binaries","Code Signing and Notarizing Python CLI Binaries",{"path":1844,"title":1845},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":1847,"title":1848},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":1850,"title":1851},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":1853,"title":1854},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Freducing-pyinstaller-binary-size","Reducing the Size of a PyInstaller CLI Binary",{"path":1856,"title":1857},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fshipping-a-cli-as-a-zipapp-with-shiv","Shipping a CLI as a Zipapp with shiv",{"path":1859,"title":1860},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":1862,"title":1863},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":1865,"title":1866},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fenforcing-import-boundaries-in-a-cli-codebase","Enforcing Import Boundaries in a Python CLI Codebase",{"path":1868,"title":1869},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Ffinding-unused-code-and-dependencies-with-vulture-and-deptry","Finding Unused Code and Dependencies with vulture and deptry",{"path":1871,"title":1872},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":1874,"title":1875},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Frunning-pyright-in-strict-mode-on-a-cli","Running Pyright in Strict Mode on a Python CLI",{"path":1877,"title":1878},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Frunning-ruff-and-mypy-in-ci-with-annotations","Running Ruff and mypy in CI with Inline Annotations",{"path":1880,"title":1881},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Ftype-checking-click-and-typer-code-with-mypy","Type-Checking Click and Typer Code with mypy",{"path":1883,"title":1884},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":1886,"title":1887},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fbumping-versions-consistently-across-a-cli-project","Bumping Versions Consistently Across a Python CLI Project",{"path":1889,"title":1890},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fderiving-versions-from-git-tags-with-hatch-vcs","Deriving CLI Versions from Git Tags with hatch-vcs",{"path":1892,"title":1893},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":1895,"title":1896},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":1173,"title":5},{"path":1899,"title":1900},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fshipping-pre-releases-and-release-candidates","Shipping Pre-Releases and Release Candidates of a Python CLI",{"path":1902,"title":1903},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":1905,"title":1906},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":1908,"title":1909},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fchoosing-a-build-backend-for-a-python-cli","Choosing a Build Backend for a Python CLI",{"path":1911,"title":1912},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":1914,"title":1915},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":1917,"title":1918},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Foptional-dependencies-and-extras-for-clis","Optional Dependencies and Extras for Python CLIs",{"path":1920,"title":1921},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":1923,"title":1924},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fwriting-pyproject-toml-metadata-for-a-cli","Writing pyproject.toml Metadata for a Python CLI",{"path":1926,"title":1927},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fdynamic-versioning-with-poetry-plugins","Dynamic Versioning for a Poetry CLI from Git Tags",{"path":1929,"title":1930},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":1932,"title":1933},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmanaging-poetry-lock-files-for-cli-tools","Managing Poetry Lock Files for CLI Tools",{"path":1935,"title":1936},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmigrating-a-cli-from-poetry-to-uv","Migrating a Python CLI from Poetry to uv",{"path":1938,"title":1939},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":1941,"title":1942},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":1944,"title":1945},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpublishing-a-cli-with-poetry","Building and Publishing a Python CLI with Poetry",{"path":1947,"title":1948},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":1950,"title":1951},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Fkeeping-hook-versions-current-with-autoupdate","Keeping pre-commit Hook Versions Current with autoupdate",{"path":1953,"title":1954},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Frunning-pre-commit-in-ci","Running pre-commit in CI for a Python CLI Repository",{"path":1956,"title":1957},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Fsetting-up-pre-commit-for-python-cli-repos","Setting up pre-commit for Python CLI repos",{"path":1959,"title":1960},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Fshipping-your-cli-as-a-pre-commit-hook","Shipping Your Python CLI as a pre-commit Hook",{"path":1962,"title":1963},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Fspeeding-up-slow-pre-commit-hooks","Speeding Up Slow pre-commit Hooks in a CLI Repository",{"path":1965,"title":1966},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Fwriting-local-pre-commit-hooks-in-python","Writing Local pre-commit Hooks in Python",{"path":1968,"title":1969},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fauditing-dependencies-with-pip-audit","Auditing a Python CLI’s Dependencies with pip-audit",{"path":1971,"title":1972},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fgenerating-an-sbom-for-a-python-cli","Generating an SBOM for a Python CLI Release",{"path":1974,"title":1975},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain","Securing the Supply Chain of a Python CLI",{"path":1977,"title":1978},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpinning-dependencies-with-hashes","Pinning a Python CLI’s Dependencies with Hashes",{"path":1980,"title":1981},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpublishing-attestations-and-verifying-releases","Publishing Attestations and Verifying Python CLI Releases",{"path":1983,"title":1984},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fbuilding-and-publishing-a-cli-with-uv","Building and Publishing a Python CLI with uv",{"path":1986,"title":1987},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":1989,"title":1990},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Flocking-and-syncing-cli-dependencies-with-uv","Locking and Syncing a Python CLI’s Dependencies with uv",{"path":1992,"title":1993},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Frunning-one-off-cli-scripts-with-uv-run","Running One-Off CLI Scripts with uv run and PEP 723",{"path":1995,"title":1996},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fusing-private-package-indexes-with-uv","Using Private Package Indexes with uv for Internal CLIs",{"path":1998,"title":1999},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-init-vs-poetry-init-for-cli-tools","uv init vs poetry init for CLI tools",{"path":2001,"title":2002},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-tool-install-vs-pipx-for-clis","uv tool install vs pipx for CLIs",{"path":2004,"title":2005},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":2007,"title":2008},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fdebugging-wrong-python-and-wrong-venv-problems","Debugging Wrong-Python and Wrong-Venv Problems in CLIs",{"path":2010,"title":2011},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fexternally-managed-environments-and-pep-668","PEP 668 and Python CLIs: the externally-managed-environment Error",{"path":2013,"title":2014},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":2016,"title":2017},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fisolating-cli-tools-from-project-dependencies","Isolating CLI Tools from Your Project’s Dependencies",{"path":2019,"title":2020},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":2022,"title":2023},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":2025,"title":2026},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1790967542764]