[{"data":1,"prerenderedAt":2624},["ShallowReactive",2],{"page-\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently\u002F":3,"content-directory":2076},{"id":4,"title":5,"body":6,"date":2061,"description":2062,"difficulty":2063,"draft":2064,"extension":2065,"meta":2066,"navigation":390,"path":2067,"seo":2068,"stem":2069,"tags":2070,"updated":2061,"__hash__":2075},"content\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently\u002Findex.md","Naming Commands and Flags Consistently in Python CLIs",{"type":7,"value":8,"toc":2043},"minimark",[9,72,77,90,94,97,101,140,173,177,180,313,317,324,643,993,1012,1015,1019,1065,1069,1072,1889,1915,1919,1922,1926,1931,1952,1956,1963,1967,1970,1974,1985,1996,2003,2007,2039],[10,11,12,16,17,16,20,23,24,27,28,31,32,35,36,39,40,43,44,47,48,43,51,54,55,57,58,61,62,65,66,71],"p",{},[13,14,15],"code",{},"mytool sites ls",", ",[13,18,19],{},"mytool build list",[13,21,22],{},"mytool user show-all",". ",[13,25,26],{},"--output-file"," on one command, ",[13,29,30],{},"--out"," on another, ",[13,33,34],{},"-o"," meaning output format on a third. ",[13,37,38],{},"--force"," spelled ",[13,41,42],{},"-f"," in ",[13,45,46],{},"delete"," and ",[13,49,50],{},"-F",[13,52,53],{},"deploy",", where ",[13,56,42],{}," means ",[13,59,60],{},"--file",". Each name was reasonable when it was chosen; together they make a tool that users have to look up every time, and that nobody can script against without reading ",[13,63,64],{},"--help"," for each command. Naming is the cheapest part of a CLI to get right and one of the most expensive to fix later, because every name is a public interface. This guide sets out a small vocabulary for commands and flags, the rules that keep names consistent as a tool grows, how to handle aliases and legacy names, and — the part that makes it stick — a test that walks your command tree and fails when a name breaks the rules. It belongs to the ",[67,68,70],"a",{"href":69},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002F","designing CLI interfaces and conventions topic",".",[73,74,76],"h2",{"id":75},"prerequisites","Prerequisites",[78,79,80,84],"ul",{},[81,82,83],"li",{},"A Typer or Click CLI with more than a handful of commands (the test below works with both).",[81,85,86,87,71],{},"A decision about the shape of the command tree; see ",[67,88,89],{"href":69},"the topic overview",[73,91,93],{"id":92},"a-vocabulary-for-commands","A vocabulary for commands",[10,95,96],{},"Most CLI commands do one of a handful of things to a resource. Pick one word for each, write it down, and use it everywhere:",[98,99],"inline-diagram",{"name":100},"nm-vocabulary",[10,102,103,106,107,23,110,113,114,16,117,47,120,122,123,127,128,16,130,16,133,16,136,139],{},[13,104,105],{},"list"," returns many items in summary form and supports filters and ",[13,108,109],{},"--limit",[13,111,112],{},"show"," returns one item in detail, identified by a positional argument. ",[13,115,116],{},"create",[13,118,119],{},"update",[13,121,46],{}," change things and follow the safety pattern in ",[67,124,126],{"href":125},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fadding-dry-run-and-confirmation-to-destructive-commands\u002F","adding dry-run and confirmation to destructive commands",". Domain-specific verbs — ",[13,129,53],{},[13,131,132],{},"sync",[13,134,135],{},"rollback",[13,137,138],{},"login"," — are fine where they describe the action better than a CRUD verb, as long as each has one name.",[10,141,142,143,147,148,150,151,154,155,158,159,161,162,154,165,168,169,172],{},"The anti-pattern is ",[144,145,146],"strong",{},"synonyms",": ",[13,149,105],{}," in one group and ",[13,152,153],{},"ls"," or ",[13,156,157],{},"get"," in another, ",[13,160,46],{}," here and ",[13,163,164],{},"remove",[13,166,167],{},"rm"," there. Users do not know which variant a given command uses, so they guess, and guess wrong. If people want short forms, add them as ",[144,170,171],{},"documented aliases"," of the canonical name — never as the canonical name of some commands but not others.",[73,174,176],{"id":175},"rules-for-flags","Rules for flags",[98,178],{"name":179},"nm-flag-rules",[78,181,182,208,248,268,281,301],{},[81,183,184,187,188,16,191,193,194,154,197,200,201,204,205,207],{},[144,185,186],{},"Long names in lowercase kebab-case",", always: ",[13,189,190],{},"--dry-run",[13,192,26],{},". Never ",[13,195,196],{},"--dryRun",[13,198,199],{},"--output_file",". Typer converts ",[13,202,203],{},"dry_run"," parameters to ",[13,206,190],{}," automatically.",[81,209,210,213,214,217,218,221,222,225,226,228,229,231,232,235,236,239,240,243,244,247],{},[144,211,212],{},"Short flags only for frequently typed options",", and with their conventional meanings: ",[13,215,216],{},"-h"," help, ",[13,219,220],{},"-v"," verbose, ",[13,223,224],{},"-q"," quiet, ",[13,227,34],{}," output, ",[13,230,42],{}," force, ",[13,233,234],{},"-n"," dry run (or count, as in ",[13,237,238],{},"head -n","), ",[13,241,242],{},"-y"," yes, ",[13,245,246],{},"-C"," directory. Do not reuse a conventional letter for something else; users' fingers will not forgive you.",[81,249,250,147,253,16,256,259,260,263,264,267],{},[144,251,252],{},"Positive booleans with generated negation",[13,254,255],{},"--color\u002F--no-color",[13,257,258],{},"--verify\u002F--no-verify",". The default goes in the positive name's help. Avoid names that are already negative (",[13,261,262],{},"--disable-cache","), because their negation (",[13,265,266],{},"--no-disable-cache",") is unreadable.",[81,269,270,147,273,276,277,280],{},[144,271,272],{},"Units in the name when a number is ambiguous",[13,274,275],{},"--timeout-seconds 30",", or accept a duration string with units (",[13,278,279],{},"--timeout 30s",") and parse it strictly.",[81,282,283,286,287,290,291,154,293,296,297,300],{},[144,284,285],{},"One meaning per name across the whole tool."," If ",[13,288,289],{},"--output"," means \"format\" in one command, it must not mean \"file path\" in another. Use ",[13,292,26],{},[13,294,295],{},"-o FILE"," consistently for the path, ",[13,298,299],{},"--format"," for the format, and never mix them.",[81,302,303,147,306,309,310,71],{},[144,304,305],{},"Singular names for repeatable options",[13,307,308],{},"--tag a --tag b",", not ",[13,311,312],{},"--tags a --tags b",[73,314,316],{"id":315},"the-recipe-shared-definitions","The recipe: shared definitions",[10,318,319,320,323],{},"Consistency is easiest when common options are defined once. In Typer, ",[13,321,322],{},"Annotated"," type aliases carry the flag names, help text and validation, and every command reuses them:",[325,326,331],"pre",{"className":327,"code":328,"language":329,"meta":330,"style":330},"language-python shiki shiki-themes github-light github-dark","# src\u002Fmytool\u002Foptions.py\nfrom enum import Enum\nfrom pathlib import Path\nfrom typing import Annotated\n\nimport typer\n\n\nclass Format(str, Enum):\n    table = \"table\"\n    json = \"json\"\n\n\nFormatOpt = Annotated[Format, typer.Option(\"--format\", \"-o\", help=\"Output format.\")]\nLimitOpt = Annotated[int, typer.Option(\"--limit\", \"-n\", min=1, help=\"Show at most N items.\")]\nDryRunOpt = Annotated[bool, typer.Option(\"--dry-run\", help=\"Show what would change; change nothing.\")]\nYesOpt = Annotated[bool, typer.Option(\"--yes\", \"-y\", help=\"Do not ask for confirmation.\")]\nOutFileOpt = Annotated[Path | None, typer.Option(\"--output-file\", help=\"Write results to FILE.\")]\n","python","",[13,332,333,342,359,372,385,392,400,405,410,435,448,459,464,469,502,548,577,610],{"__ignoreMap":330},[334,335,338],"span",{"class":336,"line":337},"line",1,[334,339,341],{"class":340},"sJ8bj","# src\u002Fmytool\u002Foptions.py\n",[334,343,345,349,353,356],{"class":336,"line":344},2,[334,346,348],{"class":347},"szBVR","from",[334,350,352],{"class":351},"sVt8B"," enum ",[334,354,355],{"class":347},"import",[334,357,358],{"class":351}," Enum\n",[334,360,362,364,367,369],{"class":336,"line":361},3,[334,363,348],{"class":347},[334,365,366],{"class":351}," pathlib ",[334,368,355],{"class":347},[334,370,371],{"class":351}," Path\n",[334,373,375,377,380,382],{"class":336,"line":374},4,[334,376,348],{"class":347},[334,378,379],{"class":351}," typing ",[334,381,355],{"class":347},[334,383,384],{"class":351}," Annotated\n",[334,386,388],{"class":336,"line":387},5,[334,389,391],{"emptyLinePlaceholder":390},true,"\n",[334,393,395,397],{"class":336,"line":394},6,[334,396,355],{"class":347},[334,398,399],{"class":351}," typer\n",[334,401,403],{"class":336,"line":402},7,[334,404,391],{"emptyLinePlaceholder":390},[334,406,408],{"class":336,"line":407},8,[334,409,391],{"emptyLinePlaceholder":390},[334,411,413,416,420,423,427,429,432],{"class":336,"line":412},9,[334,414,415],{"class":347},"class",[334,417,419],{"class":418},"sScJk"," Format",[334,421,422],{"class":351},"(",[334,424,426],{"class":425},"sj4cs","str",[334,428,16],{"class":351},[334,430,431],{"class":418},"Enum",[334,433,434],{"class":351},"):\n",[334,436,438,441,444],{"class":336,"line":437},10,[334,439,440],{"class":351},"    table ",[334,442,443],{"class":347},"=",[334,445,447],{"class":446},"sZZnC"," \"table\"\n",[334,449,451,454,456],{"class":336,"line":450},11,[334,452,453],{"class":351},"    json ",[334,455,443],{"class":347},[334,457,458],{"class":446}," \"json\"\n",[334,460,462],{"class":336,"line":461},12,[334,463,391],{"emptyLinePlaceholder":390},[334,465,467],{"class":336,"line":466},13,[334,468,391],{"emptyLinePlaceholder":390},[334,470,472,475,477,480,483,485,488,490,494,496,499],{"class":336,"line":471},14,[334,473,474],{"class":351},"FormatOpt ",[334,476,443],{"class":347},[334,478,479],{"class":351}," Annotated[Format, typer.Option(",[334,481,482],{"class":446},"\"--format\"",[334,484,16],{"class":351},[334,486,487],{"class":446},"\"-o\"",[334,489,16],{"class":351},[334,491,493],{"class":492},"s4XuR","help",[334,495,443],{"class":347},[334,497,498],{"class":446},"\"Output format.\"",[334,500,501],{"class":351},")]\n",[334,503,505,508,510,513,516,519,522,524,527,529,532,534,537,539,541,543,546],{"class":336,"line":504},15,[334,506,507],{"class":351},"LimitOpt ",[334,509,443],{"class":347},[334,511,512],{"class":351}," Annotated[",[334,514,515],{"class":425},"int",[334,517,518],{"class":351},", typer.Option(",[334,520,521],{"class":446},"\"--limit\"",[334,523,16],{"class":351},[334,525,526],{"class":446},"\"-n\"",[334,528,16],{"class":351},[334,530,531],{"class":492},"min",[334,533,443],{"class":347},[334,535,536],{"class":425},"1",[334,538,16],{"class":351},[334,540,493],{"class":492},[334,542,443],{"class":347},[334,544,545],{"class":446},"\"Show at most N items.\"",[334,547,501],{"class":351},[334,549,551,554,556,558,561,563,566,568,570,572,575],{"class":336,"line":550},16,[334,552,553],{"class":351},"DryRunOpt ",[334,555,443],{"class":347},[334,557,512],{"class":351},[334,559,560],{"class":425},"bool",[334,562,518],{"class":351},[334,564,565],{"class":446},"\"--dry-run\"",[334,567,16],{"class":351},[334,569,493],{"class":492},[334,571,443],{"class":347},[334,573,574],{"class":446},"\"Show what would change; change nothing.\"",[334,576,501],{"class":351},[334,578,580,583,585,587,589,591,594,596,599,601,603,605,608],{"class":336,"line":579},17,[334,581,582],{"class":351},"YesOpt ",[334,584,443],{"class":347},[334,586,512],{"class":351},[334,588,560],{"class":425},[334,590,518],{"class":351},[334,592,593],{"class":446},"\"--yes\"",[334,595,16],{"class":351},[334,597,598],{"class":446},"\"-y\"",[334,600,16],{"class":351},[334,602,493],{"class":492},[334,604,443],{"class":347},[334,606,607],{"class":446},"\"Do not ask for confirmation.\"",[334,609,501],{"class":351},[334,611,613,616,618,621,624,627,629,632,634,636,638,641],{"class":336,"line":612},18,[334,614,615],{"class":351},"OutFileOpt ",[334,617,443],{"class":347},[334,619,620],{"class":351}," Annotated[Path ",[334,622,623],{"class":347},"|",[334,625,626],{"class":425}," None",[334,628,518],{"class":351},[334,630,631],{"class":446},"\"--output-file\"",[334,633,16],{"class":351},[334,635,493],{"class":492},[334,637,443],{"class":347},[334,639,640],{"class":446},"\"Write results to FILE.\"",[334,642,501],{"class":351},[325,644,646],{"className":327,"code":645,"language":329,"meta":330,"style":330},"# src\u002Fmytool\u002Fcli.py\nimport typer\n\nfrom mytool.options import DryRunOpt, Format, FormatOpt, LimitOpt, YesOpt\n\napp = typer.Typer(no_args_is_help=True)\nsites = typer.Typer(no_args_is_help=True, help=\"Manage sites.\")\nbuilds = typer.Typer(no_args_is_help=True, help=\"Inspect builds.\")\napp.add_typer(sites, name=\"site\")\napp.add_typer(builds, name=\"build\")\n\n\n@sites.command(\"list\")\ndef site_list(fmt: FormatOpt = Format.table, limit: LimitOpt = 20) -> None:\n    \"\"\"List sites.\"\"\"\n\n\n@sites.command(\"delete\")\ndef site_delete(name: str, dry_run: DryRunOpt = False, yes: YesOpt = False) -> None:\n    \"\"\"Delete a site.\"\"\"\n\n\n@builds.command(\"list\")\ndef build_list(fmt: FormatOpt = Format.table, limit: LimitOpt = 20) -> None:\n    \"\"\"List recent builds.\"\"\"\n\n\n# A documented, hidden alias: muscle memory works, --help stays clean.\nsites.command(\"ls\", hidden=True, help=\"Alias for 'list'.\")(site_list)\n",[13,647,648,653,659,663,675,679,700,726,752,767,781,785,789,801,831,836,840,844,855,889,895,900,905,917,941,947,952,957,963],{"__ignoreMap":330},[334,649,650],{"class":336,"line":337},[334,651,652],{"class":340},"# src\u002Fmytool\u002Fcli.py\n",[334,654,655,657],{"class":336,"line":344},[334,656,355],{"class":347},[334,658,399],{"class":351},[334,660,661],{"class":336,"line":361},[334,662,391],{"emptyLinePlaceholder":390},[334,664,665,667,670,672],{"class":336,"line":374},[334,666,348],{"class":347},[334,668,669],{"class":351}," mytool.options ",[334,671,355],{"class":347},[334,673,674],{"class":351}," DryRunOpt, Format, FormatOpt, LimitOpt, YesOpt\n",[334,676,677],{"class":336,"line":387},[334,678,391],{"emptyLinePlaceholder":390},[334,680,681,684,686,689,692,694,697],{"class":336,"line":394},[334,682,683],{"class":351},"app ",[334,685,443],{"class":347},[334,687,688],{"class":351}," typer.Typer(",[334,690,691],{"class":492},"no_args_is_help",[334,693,443],{"class":347},[334,695,696],{"class":425},"True",[334,698,699],{"class":351},")\n",[334,701,702,705,707,709,711,713,715,717,719,721,724],{"class":336,"line":402},[334,703,704],{"class":351},"sites ",[334,706,443],{"class":347},[334,708,688],{"class":351},[334,710,691],{"class":492},[334,712,443],{"class":347},[334,714,696],{"class":425},[334,716,16],{"class":351},[334,718,493],{"class":492},[334,720,443],{"class":347},[334,722,723],{"class":446},"\"Manage sites.\"",[334,725,699],{"class":351},[334,727,728,731,733,735,737,739,741,743,745,747,750],{"class":336,"line":407},[334,729,730],{"class":351},"builds ",[334,732,443],{"class":347},[334,734,688],{"class":351},[334,736,691],{"class":492},[334,738,443],{"class":347},[334,740,696],{"class":425},[334,742,16],{"class":351},[334,744,493],{"class":492},[334,746,443],{"class":347},[334,748,749],{"class":446},"\"Inspect builds.\"",[334,751,699],{"class":351},[334,753,754,757,760,762,765],{"class":336,"line":412},[334,755,756],{"class":351},"app.add_typer(sites, ",[334,758,759],{"class":492},"name",[334,761,443],{"class":347},[334,763,764],{"class":446},"\"site\"",[334,766,699],{"class":351},[334,768,769,772,774,776,779],{"class":336,"line":437},[334,770,771],{"class":351},"app.add_typer(builds, ",[334,773,759],{"class":492},[334,775,443],{"class":347},[334,777,778],{"class":446},"\"build\"",[334,780,699],{"class":351},[334,782,783],{"class":336,"line":450},[334,784,391],{"emptyLinePlaceholder":390},[334,786,787],{"class":336,"line":461},[334,788,391],{"emptyLinePlaceholder":390},[334,790,791,794,796,799],{"class":336,"line":466},[334,792,793],{"class":418},"@sites.command",[334,795,422],{"class":351},[334,797,798],{"class":446},"\"list\"",[334,800,699],{"class":351},[334,802,803,806,809,812,814,817,819,822,825,828],{"class":336,"line":471},[334,804,805],{"class":347},"def",[334,807,808],{"class":418}," site_list",[334,810,811],{"class":351},"(fmt: FormatOpt ",[334,813,443],{"class":347},[334,815,816],{"class":351}," Format.table, limit: LimitOpt ",[334,818,443],{"class":347},[334,820,821],{"class":425}," 20",[334,823,824],{"class":351},") -> ",[334,826,827],{"class":425},"None",[334,829,830],{"class":351},":\n",[334,832,833],{"class":336,"line":504},[334,834,835],{"class":446},"    \"\"\"List sites.\"\"\"\n",[334,837,838],{"class":336,"line":550},[334,839,391],{"emptyLinePlaceholder":390},[334,841,842],{"class":336,"line":579},[334,843,391],{"emptyLinePlaceholder":390},[334,845,846,848,850,853],{"class":336,"line":612},[334,847,793],{"class":418},[334,849,422],{"class":351},[334,851,852],{"class":446},"\"delete\"",[334,854,699],{"class":351},[334,856,858,860,863,866,868,871,873,876,879,881,883,885,887],{"class":336,"line":857},19,[334,859,805],{"class":347},[334,861,862],{"class":418}," site_delete",[334,864,865],{"class":351},"(name: ",[334,867,426],{"class":425},[334,869,870],{"class":351},", dry_run: DryRunOpt ",[334,872,443],{"class":347},[334,874,875],{"class":425}," False",[334,877,878],{"class":351},", yes: YesOpt ",[334,880,443],{"class":347},[334,882,875],{"class":425},[334,884,824],{"class":351},[334,886,827],{"class":425},[334,888,830],{"class":351},[334,890,892],{"class":336,"line":891},20,[334,893,894],{"class":446},"    \"\"\"Delete a site.\"\"\"\n",[334,896,898],{"class":336,"line":897},21,[334,899,391],{"emptyLinePlaceholder":390},[334,901,903],{"class":336,"line":902},22,[334,904,391],{"emptyLinePlaceholder":390},[334,906,908,911,913,915],{"class":336,"line":907},23,[334,909,910],{"class":418},"@builds.command",[334,912,422],{"class":351},[334,914,798],{"class":446},[334,916,699],{"class":351},[334,918,920,922,925,927,929,931,933,935,937,939],{"class":336,"line":919},24,[334,921,805],{"class":347},[334,923,924],{"class":418}," build_list",[334,926,811],{"class":351},[334,928,443],{"class":347},[334,930,816],{"class":351},[334,932,443],{"class":347},[334,934,821],{"class":425},[334,936,824],{"class":351},[334,938,827],{"class":425},[334,940,830],{"class":351},[334,942,944],{"class":336,"line":943},25,[334,945,946],{"class":446},"    \"\"\"List recent builds.\"\"\"\n",[334,948,950],{"class":336,"line":949},26,[334,951,391],{"emptyLinePlaceholder":390},[334,953,955],{"class":336,"line":954},27,[334,956,391],{"emptyLinePlaceholder":390},[334,958,960],{"class":336,"line":959},28,[334,961,962],{"class":340},"# A documented, hidden alias: muscle memory works, --help stays clean.\n",[334,964,966,969,972,974,977,979,981,983,985,987,990],{"class":336,"line":965},29,[334,967,968],{"class":351},"sites.command(",[334,970,971],{"class":446},"\"ls\"",[334,973,16],{"class":351},[334,975,976],{"class":492},"hidden",[334,978,443],{"class":347},[334,980,696],{"class":425},[334,982,16],{"class":351},[334,984,493],{"class":492},[334,986,443],{"class":347},[334,988,989],{"class":446},"\"Alias for 'list'.\"",[334,991,992],{"class":351},")(site_list)\n",[10,994,995,996,47,999,1002,1003,1007,1008,71],{},"Every list command now has identical ",[13,997,998],{},"--format\u002F-o",[13,1000,1001],{},"--limit\u002F-n"," options, with the same help text and validation, and a new list command gets them by writing two type annotations. The technique is covered in more depth in ",[67,1004,1006],{"href":1005},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer\u002F","using Annotated options in Typer"," and, for Click, ",[67,1009,1011],{"href":1010},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands\u002F","sharing common options across commands",[98,1013],{"name":1014},"nm-help-terminal",[73,1016,1018],{"id":1017},"ux-considerations","UX considerations",[78,1020,1021,1034,1040,1055],{},[81,1022,1023,1026,1027,1029,1030,1033],{},[144,1024,1025],{},"Names are for typing and reading."," Prefer short, common English words over clever ones. ",[13,1028,132],{}," beats ",[13,1031,1032],{},"reconcile"," unless your users already say \"reconcile\".",[81,1035,1036,1039],{},[144,1037,1038],{},"Match your users' domain words."," If the team calls them \"environments\", do not call them \"stages\" in the CLI. The interface should use the vocabulary people already speak.",[81,1041,1042,1045,1046,1048,1049,1051,1052,1054],{},[144,1043,1044],{},"Keep aliases few and documented."," One short alias per frequently used command (",[13,1047,153],{}," for ",[13,1050,105],{},") is helpful; a cloud of synonyms is not. Hidden aliases keep ",[13,1053,64],{}," clean while old scripts and muscle memory keep working.",[81,1056,1057,1060,1061,71],{},[144,1058,1059],{},"Plan for renames."," When a name must change, add the new one, deprecate the old with a warning naming the replacement, and remove it in the next major version, per ",[67,1062,1064],{"href":1063},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools\u002F","semantic versioning policy for CLI tools",[73,1066,1068],{"id":1067},"testing-the-behaviour","Testing the behaviour",[10,1070,1071],{},"Rules written in a style guide drift; rules checked in CI hold. Typer apps expose their underlying Click command tree, which a test can walk to check every command and option name:",[325,1073,1075],{"className":327,"code":1074,"language":329,"meta":330,"style":330},"# tests\u002Ftest_naming.py\nimport re\n\nimport typer\n\nfrom mytool.cli import app\n\nVERBS = {\"list\", \"show\", \"create\", \"update\", \"delete\", \"deploy\", \"sync\", \"login\", \"logout\", \"prune\"}\nKEBAB = re.compile(r\"^--[a-z][a-z0-9]*(-[a-z0-9]+)*$\")\nRESERVED_SHORT = {\"-v\": \"--verbose\", \"-q\": \"--quiet\", \"-o\": \"--format\", \"-n\": \"--limit\",\n                  \"-y\": \"--yes\", \"-f\": \"--force\", \"-h\": \"--help\"}\n\n\ndef walk(cmd, path: tuple[str, ...] = ()):\n    \"\"\"Yield (path, command) for every command. Duck-typed: works for Click and Typer trees.\"\"\"\n    yield path, cmd\n    for name, sub in getattr(cmd, \"commands\", {}).items():\n        yield from walk(sub, path + (name,))\n\n\ndef is_group(cmd) -> bool:\n    return hasattr(cmd, \"commands\")\n\n\ndef test_the_walk_sees_every_command():\n    names = {\" \".join(path) for path, _ in walk(typer.main.get_command(app))}\n    assert {\"site list\", \"site delete\", \"build list\"} \u003C= names\n\n\ndef test_leaf_commands_use_known_verbs():\n    for path, cmd in walk(typer.main.get_command(app)):\n        if path and not is_group(cmd) and not cmd.hidden:\n            assert path[-1] in VERBS, f\"'{' '.join(path)}' uses a verb outside the vocabulary\"\n\n\ndef test_long_options_are_kebab_case():\n    for path, cmd in walk(typer.main.get_command(app)):\n        for param in cmd.params:\n            for opt in [o for o in getattr(param, \"opts\", []) + getattr(param, \"secondary_opts\", [])\n                        if o.startswith(\"--\")]:\n                assert KEBAB.match(opt), f\"{' '.join(path)}: {opt} is not kebab-case\"\n\n\ndef test_short_flags_keep_their_conventional_meaning():\n    for path, cmd in walk(typer.main.get_command(app)):\n        for param in cmd.params:\n            opts = getattr(param, \"opts\", [])\n            for short, expected_long in RESERVED_SHORT.items():\n                if short in opts:\n                    assert expected_long in opts, (\n                        f\"{' '.join(path)}: {short} is paired with {opts}, expected {expected_long}\")\n",[13,1076,1077,1082,1089,1093,1099,1103,1115,1119,1179,1231,1277,1308,1312,1316,1341,1346,1354,1377,1390,1394,1398,1412,1426,1430,1434,1444,1470,1499,1503,1507,1517,1530,1555,1598,1603,1608,1618,1629,1643,1687,1702,1738,1743,1748,1758,1769,1780,1796,1812,1826,1840],{"__ignoreMap":330},[334,1078,1079],{"class":336,"line":337},[334,1080,1081],{"class":340},"# tests\u002Ftest_naming.py\n",[334,1083,1084,1086],{"class":336,"line":344},[334,1085,355],{"class":347},[334,1087,1088],{"class":351}," re\n",[334,1090,1091],{"class":336,"line":361},[334,1092,391],{"emptyLinePlaceholder":390},[334,1094,1095,1097],{"class":336,"line":374},[334,1096,355],{"class":347},[334,1098,399],{"class":351},[334,1100,1101],{"class":336,"line":387},[334,1102,391],{"emptyLinePlaceholder":390},[334,1104,1105,1107,1110,1112],{"class":336,"line":394},[334,1106,348],{"class":347},[334,1108,1109],{"class":351}," mytool.cli ",[334,1111,355],{"class":347},[334,1113,1114],{"class":351}," app\n",[334,1116,1117],{"class":336,"line":402},[334,1118,391],{"emptyLinePlaceholder":390},[334,1120,1121,1124,1127,1130,1132,1134,1137,1139,1142,1144,1147,1149,1151,1153,1156,1158,1161,1163,1166,1168,1171,1173,1176],{"class":336,"line":407},[334,1122,1123],{"class":425},"VERBS",[334,1125,1126],{"class":347}," =",[334,1128,1129],{"class":351}," {",[334,1131,798],{"class":446},[334,1133,16],{"class":351},[334,1135,1136],{"class":446},"\"show\"",[334,1138,16],{"class":351},[334,1140,1141],{"class":446},"\"create\"",[334,1143,16],{"class":351},[334,1145,1146],{"class":446},"\"update\"",[334,1148,16],{"class":351},[334,1150,852],{"class":446},[334,1152,16],{"class":351},[334,1154,1155],{"class":446},"\"deploy\"",[334,1157,16],{"class":351},[334,1159,1160],{"class":446},"\"sync\"",[334,1162,16],{"class":351},[334,1164,1165],{"class":446},"\"login\"",[334,1167,16],{"class":351},[334,1169,1170],{"class":446},"\"logout\"",[334,1172,16],{"class":351},[334,1174,1175],{"class":446},"\"prune\"",[334,1177,1178],{"class":351},"}\n",[334,1180,1181,1184,1186,1189,1192,1195,1198,1202,1205,1208,1210,1213,1216,1219,1222,1224,1227,1229],{"class":336,"line":412},[334,1182,1183],{"class":425},"KEBAB",[334,1185,1126],{"class":347},[334,1187,1188],{"class":351}," re.compile(",[334,1190,1191],{"class":347},"r",[334,1193,1194],{"class":446},"\"",[334,1196,1197],{"class":425},"^",[334,1199,1201],{"class":1200},"sA_wV","--",[334,1203,1204],{"class":425},"[a-z][a-z0-9]",[334,1206,1207],{"class":347},"*",[334,1209,422],{"class":425},[334,1211,1212],{"class":1200},"-",[334,1214,1215],{"class":425},"[a-z0-9]",[334,1217,1218],{"class":347},"+",[334,1220,1221],{"class":425},")",[334,1223,1207],{"class":347},[334,1225,1226],{"class":425},"$",[334,1228,1194],{"class":446},[334,1230,699],{"class":351},[334,1232,1233,1236,1238,1240,1243,1245,1248,1250,1253,1255,1258,1260,1262,1264,1266,1268,1270,1272,1274],{"class":336,"line":437},[334,1234,1235],{"class":425},"RESERVED_SHORT",[334,1237,1126],{"class":347},[334,1239,1129],{"class":351},[334,1241,1242],{"class":446},"\"-v\"",[334,1244,147],{"class":351},[334,1246,1247],{"class":446},"\"--verbose\"",[334,1249,16],{"class":351},[334,1251,1252],{"class":446},"\"-q\"",[334,1254,147],{"class":351},[334,1256,1257],{"class":446},"\"--quiet\"",[334,1259,16],{"class":351},[334,1261,487],{"class":446},[334,1263,147],{"class":351},[334,1265,482],{"class":446},[334,1267,16],{"class":351},[334,1269,526],{"class":446},[334,1271,147],{"class":351},[334,1273,521],{"class":446},[334,1275,1276],{"class":351},",\n",[334,1278,1279,1282,1284,1286,1288,1291,1293,1296,1298,1301,1303,1306],{"class":336,"line":450},[334,1280,1281],{"class":446},"                  \"-y\"",[334,1283,147],{"class":351},[334,1285,593],{"class":446},[334,1287,16],{"class":351},[334,1289,1290],{"class":446},"\"-f\"",[334,1292,147],{"class":351},[334,1294,1295],{"class":446},"\"--force\"",[334,1297,16],{"class":351},[334,1299,1300],{"class":446},"\"-h\"",[334,1302,147],{"class":351},[334,1304,1305],{"class":446},"\"--help\"",[334,1307,1178],{"class":351},[334,1309,1310],{"class":336,"line":461},[334,1311,391],{"emptyLinePlaceholder":390},[334,1313,1314],{"class":336,"line":466},[334,1315,391],{"emptyLinePlaceholder":390},[334,1317,1318,1320,1323,1326,1328,1330,1333,1336,1338],{"class":336,"line":471},[334,1319,805],{"class":347},[334,1321,1322],{"class":418}," walk",[334,1324,1325],{"class":351},"(cmd, path: tuple[",[334,1327,426],{"class":425},[334,1329,16],{"class":351},[334,1331,1332],{"class":425},"...",[334,1334,1335],{"class":351},"] ",[334,1337,443],{"class":347},[334,1339,1340],{"class":351}," ()):\n",[334,1342,1343],{"class":336,"line":504},[334,1344,1345],{"class":446},"    \"\"\"Yield (path, command) for every command. Duck-typed: works for Click and Typer trees.\"\"\"\n",[334,1347,1348,1351],{"class":336,"line":550},[334,1349,1350],{"class":347},"    yield",[334,1352,1353],{"class":351}," path, cmd\n",[334,1355,1356,1359,1362,1365,1368,1371,1374],{"class":336,"line":579},[334,1357,1358],{"class":347},"    for",[334,1360,1361],{"class":351}," name, sub ",[334,1363,1364],{"class":347},"in",[334,1366,1367],{"class":425}," getattr",[334,1369,1370],{"class":351},"(cmd, ",[334,1372,1373],{"class":446},"\"commands\"",[334,1375,1376],{"class":351},", {}).items():\n",[334,1378,1379,1382,1385,1387],{"class":336,"line":612},[334,1380,1381],{"class":347},"        yield from",[334,1383,1384],{"class":351}," walk(sub, path ",[334,1386,1218],{"class":347},[334,1388,1389],{"class":351}," (name,))\n",[334,1391,1392],{"class":336,"line":857},[334,1393,391],{"emptyLinePlaceholder":390},[334,1395,1396],{"class":336,"line":891},[334,1397,391],{"emptyLinePlaceholder":390},[334,1399,1400,1402,1405,1408,1410],{"class":336,"line":897},[334,1401,805],{"class":347},[334,1403,1404],{"class":418}," is_group",[334,1406,1407],{"class":351},"(cmd) -> ",[334,1409,560],{"class":425},[334,1411,830],{"class":351},[334,1413,1414,1417,1420,1422,1424],{"class":336,"line":902},[334,1415,1416],{"class":347},"    return",[334,1418,1419],{"class":425}," hasattr",[334,1421,1370],{"class":351},[334,1423,1373],{"class":446},[334,1425,699],{"class":351},[334,1427,1428],{"class":336,"line":907},[334,1429,391],{"emptyLinePlaceholder":390},[334,1431,1432],{"class":336,"line":919},[334,1433,391],{"emptyLinePlaceholder":390},[334,1435,1436,1438,1441],{"class":336,"line":943},[334,1437,805],{"class":347},[334,1439,1440],{"class":418}," test_the_walk_sees_every_command",[334,1442,1443],{"class":351},"():\n",[334,1445,1446,1449,1451,1453,1456,1459,1462,1465,1467],{"class":336,"line":949},[334,1447,1448],{"class":351},"    names ",[334,1450,443],{"class":347},[334,1452,1129],{"class":351},[334,1454,1455],{"class":446},"\" \"",[334,1457,1458],{"class":351},".join(path) ",[334,1460,1461],{"class":347},"for",[334,1463,1464],{"class":351}," path, _ ",[334,1466,1364],{"class":347},[334,1468,1469],{"class":351}," walk(typer.main.get_command(app))}\n",[334,1471,1472,1475,1477,1480,1482,1485,1487,1490,1493,1496],{"class":336,"line":954},[334,1473,1474],{"class":347},"    assert",[334,1476,1129],{"class":351},[334,1478,1479],{"class":446},"\"site list\"",[334,1481,16],{"class":351},[334,1483,1484],{"class":446},"\"site delete\"",[334,1486,16],{"class":351},[334,1488,1489],{"class":446},"\"build list\"",[334,1491,1492],{"class":351},"} ",[334,1494,1495],{"class":347},"\u003C=",[334,1497,1498],{"class":351}," names\n",[334,1500,1501],{"class":336,"line":959},[334,1502,391],{"emptyLinePlaceholder":390},[334,1504,1505],{"class":336,"line":965},[334,1506,391],{"emptyLinePlaceholder":390},[334,1508,1510,1512,1515],{"class":336,"line":1509},30,[334,1511,805],{"class":347},[334,1513,1514],{"class":418}," test_leaf_commands_use_known_verbs",[334,1516,1443],{"class":351},[334,1518,1520,1522,1525,1527],{"class":336,"line":1519},31,[334,1521,1358],{"class":347},[334,1523,1524],{"class":351}," path, cmd ",[334,1526,1364],{"class":347},[334,1528,1529],{"class":351}," walk(typer.main.get_command(app)):\n",[334,1531,1533,1536,1539,1542,1545,1548,1550,1552],{"class":336,"line":1532},32,[334,1534,1535],{"class":347},"        if",[334,1537,1538],{"class":351}," path ",[334,1540,1541],{"class":347},"and",[334,1543,1544],{"class":347}," not",[334,1546,1547],{"class":351}," is_group(cmd) ",[334,1549,1541],{"class":347},[334,1551,1544],{"class":347},[334,1553,1554],{"class":351}," cmd.hidden:\n",[334,1556,1558,1561,1564,1566,1568,1570,1572,1575,1577,1580,1583,1586,1589,1592,1595],{"class":336,"line":1557},33,[334,1559,1560],{"class":347},"            assert",[334,1562,1563],{"class":351}," path[",[334,1565,1212],{"class":347},[334,1567,536],{"class":425},[334,1569,1335],{"class":351},[334,1571,1364],{"class":347},[334,1573,1574],{"class":425}," VERBS",[334,1576,16],{"class":351},[334,1578,1579],{"class":347},"f",[334,1581,1582],{"class":446},"\"'",[334,1584,1585],{"class":425},"{",[334,1587,1588],{"class":446},"' '",[334,1590,1591],{"class":351},".join(path)",[334,1593,1594],{"class":425},"}",[334,1596,1597],{"class":446},"' uses a verb outside the vocabulary\"\n",[334,1599,1601],{"class":336,"line":1600},34,[334,1602,391],{"emptyLinePlaceholder":390},[334,1604,1606],{"class":336,"line":1605},35,[334,1607,391],{"emptyLinePlaceholder":390},[334,1609,1611,1613,1616],{"class":336,"line":1610},36,[334,1612,805],{"class":347},[334,1614,1615],{"class":418}," test_long_options_are_kebab_case",[334,1617,1443],{"class":351},[334,1619,1621,1623,1625,1627],{"class":336,"line":1620},37,[334,1622,1358],{"class":347},[334,1624,1524],{"class":351},[334,1626,1364],{"class":347},[334,1628,1529],{"class":351},[334,1630,1632,1635,1638,1640],{"class":336,"line":1631},38,[334,1633,1634],{"class":347},"        for",[334,1636,1637],{"class":351}," param ",[334,1639,1364],{"class":347},[334,1641,1642],{"class":351}," cmd.params:\n",[334,1644,1646,1649,1652,1654,1657,1659,1662,1664,1666,1669,1672,1675,1677,1679,1681,1684],{"class":336,"line":1645},39,[334,1647,1648],{"class":347},"            for",[334,1650,1651],{"class":351}," opt ",[334,1653,1364],{"class":347},[334,1655,1656],{"class":351}," [o ",[334,1658,1461],{"class":347},[334,1660,1661],{"class":351}," o ",[334,1663,1364],{"class":347},[334,1665,1367],{"class":425},[334,1667,1668],{"class":351},"(param, ",[334,1670,1671],{"class":446},"\"opts\"",[334,1673,1674],{"class":351},", []) ",[334,1676,1218],{"class":347},[334,1678,1367],{"class":425},[334,1680,1668],{"class":351},[334,1682,1683],{"class":446},"\"secondary_opts\"",[334,1685,1686],{"class":351},", [])\n",[334,1688,1690,1693,1696,1699],{"class":336,"line":1689},40,[334,1691,1692],{"class":347},"                        if",[334,1694,1695],{"class":351}," o.startswith(",[334,1697,1698],{"class":446},"\"--\"",[334,1700,1701],{"class":351},")]:\n",[334,1703,1705,1708,1711,1714,1716,1718,1720,1722,1724,1726,1728,1730,1733,1735],{"class":336,"line":1704},41,[334,1706,1707],{"class":347},"                assert",[334,1709,1710],{"class":425}," KEBAB",[334,1712,1713],{"class":351},".match(opt), ",[334,1715,1579],{"class":347},[334,1717,1194],{"class":446},[334,1719,1585],{"class":425},[334,1721,1588],{"class":446},[334,1723,1591],{"class":351},[334,1725,1594],{"class":425},[334,1727,147],{"class":446},[334,1729,1585],{"class":425},[334,1731,1732],{"class":351},"opt",[334,1734,1594],{"class":425},[334,1736,1737],{"class":446}," is not kebab-case\"\n",[334,1739,1741],{"class":336,"line":1740},42,[334,1742,391],{"emptyLinePlaceholder":390},[334,1744,1746],{"class":336,"line":1745},43,[334,1747,391],{"emptyLinePlaceholder":390},[334,1749,1751,1753,1756],{"class":336,"line":1750},44,[334,1752,805],{"class":347},[334,1754,1755],{"class":418}," test_short_flags_keep_their_conventional_meaning",[334,1757,1443],{"class":351},[334,1759,1761,1763,1765,1767],{"class":336,"line":1760},45,[334,1762,1358],{"class":347},[334,1764,1524],{"class":351},[334,1766,1364],{"class":347},[334,1768,1529],{"class":351},[334,1770,1772,1774,1776,1778],{"class":336,"line":1771},46,[334,1773,1634],{"class":347},[334,1775,1637],{"class":351},[334,1777,1364],{"class":347},[334,1779,1642],{"class":351},[334,1781,1783,1786,1788,1790,1792,1794],{"class":336,"line":1782},47,[334,1784,1785],{"class":351},"            opts ",[334,1787,443],{"class":347},[334,1789,1367],{"class":425},[334,1791,1668],{"class":351},[334,1793,1671],{"class":446},[334,1795,1686],{"class":351},[334,1797,1799,1801,1804,1806,1809],{"class":336,"line":1798},48,[334,1800,1648],{"class":347},[334,1802,1803],{"class":351}," short, expected_long ",[334,1805,1364],{"class":347},[334,1807,1808],{"class":425}," RESERVED_SHORT",[334,1810,1811],{"class":351},".items():\n",[334,1813,1815,1818,1821,1823],{"class":336,"line":1814},49,[334,1816,1817],{"class":347},"                if",[334,1819,1820],{"class":351}," short ",[334,1822,1364],{"class":347},[334,1824,1825],{"class":351}," opts:\n",[334,1827,1829,1832,1835,1837],{"class":336,"line":1828},50,[334,1830,1831],{"class":347},"                    assert",[334,1833,1834],{"class":351}," expected_long ",[334,1836,1364],{"class":347},[334,1838,1839],{"class":351}," opts, (\n",[334,1841,1843,1846,1848,1850,1852,1854,1856,1858,1860,1863,1865,1868,1870,1873,1875,1878,1880,1883,1885,1887],{"class":336,"line":1842},51,[334,1844,1845],{"class":347},"                        f",[334,1847,1194],{"class":446},[334,1849,1585],{"class":425},[334,1851,1588],{"class":446},[334,1853,1591],{"class":351},[334,1855,1594],{"class":425},[334,1857,147],{"class":446},[334,1859,1585],{"class":425},[334,1861,1862],{"class":351},"short",[334,1864,1594],{"class":425},[334,1866,1867],{"class":446}," is paired with ",[334,1869,1585],{"class":425},[334,1871,1872],{"class":351},"opts",[334,1874,1594],{"class":425},[334,1876,1877],{"class":446},", expected ",[334,1879,1585],{"class":425},[334,1881,1882],{"class":351},"expected_long",[334,1884,1594],{"class":425},[334,1886,1194],{"class":446},[334,1888,699],{"class":351},[10,1890,1891,1892,1895,1896,1899,1900,1903,1904,47,1906,1908,1909,1911,1912,1914],{},"The walk is duck-typed — it follows any object with a ",[13,1893,1894],{},"commands"," mapping — because recent Typer releases build their command tree from their own vendored copy of Click, so ",[13,1897,1898],{},"isinstance(cmd, click.Group)"," with the standalone ",[13,1901,1902],{},"click"," package would silently see only the root and every test would pass vacuously. The first test guards against exactly that by checking the walk reaches known commands. The verb test then enforces the vocabulary on leaf commands (hidden aliases are exempt). The second catches ",[13,1905,196],{},[13,1907,199],{},". The third catches the subtle one — ",[13,1910,42],{}," quietly meaning ",[13,1913,60],{}," in one command — by requiring each reserved short flag to be paired with its conventional long name wherever it appears. Extend the reserved list as your own conventions settle.",[73,1916,1918],{"id":1917},"conclusion","Conclusion",[10,1920,1921],{},"Consistent names are a small discipline with a large payoff: users learn the tool once, scripts are predictable, and completion becomes genuinely fast. Choose one verb per action, lowercase kebab-case long flags, conventional short flags used only with their conventional meanings, positive booleans with negations, and one meaning per flag across the tool. Define shared options once as type aliases or decorators, keep aliases few and hidden, rename only through deprecation — and let a test walk the command tree so the rules survive the next contributor.",[73,1923,1925],{"id":1924},"frequently-asked-questions","Frequently asked questions",[1927,1928,1930],"h3",{"id":1929},"should-command-names-be-singular-or-plural","Should command names be singular or plural?",[10,1932,1933,1934,16,1937,1940,1941,1944,1945,47,1948,1951],{},"Singular for resource groups (",[13,1935,1936],{},"site list",[13,1938,1939],{},"build prune",") reads more naturally as noun-then-verb and matches tools like ",[13,1942,1943],{},"gh",". Whatever you choose, apply it to every group; mixing ",[13,1946,1947],{},"sites list",[13,1949,1950],{},"build list"," is exactly the inconsistency this guide is about.",[1927,1953,1955],{"id":1954},"what-about-subcommands-with-multiple-words","What about subcommands with multiple words?",[10,1957,1958,1959,1962],{},"Use kebab-case (",[13,1960,1961],{},"rotate-logs","), matching flag style. Typer converts function names with underscores to kebab-case automatically; set explicit names when you want something different.",[1927,1964,1966],{"id":1965},"can-two-commands-share-a-short-flag-with-different-meanings","Can two commands share a short flag with different meanings?",[10,1968,1969],{},"Technically yes; practically no. Users type short flags from habit, and habits do not check which command they are in. Reserve each short flag for one meaning tool-wide, and give less common options only long names.",[1927,1971,1973],{"id":1972},"how-should-i-name-the-tool-itself","How should I name the tool itself?",[10,1975,1976,1977,1980,1981,71],{},"Short enough to type hundreds of times a day, distinctive enough not to collide with existing commands on your users' machines, and searchable. Check ",[13,1978,1979],{},"command -v yourname"," on a few machines and search PyPI before settling. Two to eight lowercase letters with an optional hyphen is the comfortable range; if the natural name is long, ship a short second entry point as an alias, as described in ",[67,1982,1984],{"href":1983},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fbest-practices-for-python-cli-entry-points\u002F","best practices for Python CLI entry points",[1927,1986,1988,1989,1048,1992,1995],{"id":1987},"should-flags-be-abbreviable-like-gnus-verb-for-verbose","Should flags be abbreviable, like GNU's ",[13,1990,1991],{},"--verb",[13,1993,1994],{},"--verbose","?",[10,1997,1998,1999,2002],{},"Click does not support prefix abbreviation, and that is a feature: abbreviations become ambiguous as soon as you add a new flag with the same prefix, silently breaking scripts. argparse allows them by default; set ",[13,2000,2001],{},"allow_abbrev=False"," for the same reason.",[73,2004,2006],{"id":2005},"related","Related",[78,2008,2009,2015,2021,2027,2033],{},[81,2010,2011,2012],{},"Up: ",[67,2013,2014],{"href":69},"Designing CLI interfaces and conventions",[81,2016,2017],{},[67,2018,2020],{"href":2019},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fglobal-options-vs-per-command-options\u002F","Global options vs per-command options",[81,2022,2023],{},[67,2024,2026],{"href":2025},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Ffollowing-posix-and-gnu-argument-conventions\u002F","Following POSIX and GNU argument conventions",[81,2028,2029],{},[67,2030,2032],{"href":2031},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read\u002F","Writing help text users actually read",[81,2034,2035],{},[67,2036,2038],{"href":2037},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags\u002F","Versioning and deprecating CLI flags",[2040,2041,2042],"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 .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 .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}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);}html pre.shiki code .sA_wV, html code.shiki .sA_wV{--shiki-default:#032F62;--shiki-dark:#DBEDFF}",{"title":330,"searchDepth":344,"depth":344,"links":2044},[2045,2046,2047,2048,2049,2050,2051,2052,2060],{"id":75,"depth":344,"text":76},{"id":92,"depth":344,"text":93},{"id":175,"depth":344,"text":176},{"id":315,"depth":344,"text":316},{"id":1017,"depth":344,"text":1018},{"id":1067,"depth":344,"text":1068},{"id":1917,"depth":344,"text":1918},{"id":1924,"depth":344,"text":1925,"children":2053},[2054,2055,2056,2057,2058],{"id":1929,"depth":361,"text":1930},{"id":1954,"depth":361,"text":1955},{"id":1965,"depth":361,"text":1966},{"id":1972,"depth":361,"text":1973},{"id":1987,"depth":361,"text":2059},"Should flags be abbreviable, like GNU's --verb for --verbose?",{"id":2005,"depth":344,"text":2006},"2026-09-18","Give a Python CLI a consistent vocabulary: verbs for commands, rules for flag names and short options, shared meanings, aliases, and a test that enforces them.","beginner",false,"md",{},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently",{"title":5,"description":2062},"modern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently\u002Findex",[2071,2072,2073,1902,2074],"cli-design","naming","typer","conventions","DHUovnxA8hWN4OlBcpXefSha_40mh7yVRWBw2Ep8qIw",[2077,2080,2083,2086,2089,2092,2095,2098,2101,2104,2107,2110,2113,2116,2119,2122,2125,2128,2131,2134,2137,2140,2143,2146,2149,2152,2155,2158,2161,2164,2167,2170,2173,2176,2179,2182,2185,2188,2191,2194,2197,2200,2203,2206,2209,2212,2215,2218,2221,2224,2227,2230,2233,2236,2239,2242,2245,2248,2251,2254,2257,2260,2263,2266,2269,2272,2275,2278,2281,2284,2287,2290,2293,2296,2299,2302,2305,2308,2311,2314,2317,2320,2323,2326,2329,2332,2335,2338,2341,2344,2347,2350,2353,2356,2359,2362,2365,2368,2371,2374,2377,2380,2383,2386,2389,2392,2395,2398,2399,2402,2405,2408,2411,2414,2417,2420,2423,2426,2429,2432,2435,2438,2441,2444,2447,2450,2453,2456,2459,2462,2465,2468,2471,2474,2477,2480,2483,2486,2489,2492,2495,2498,2501,2504,2507,2510,2513,2516,2519,2522,2525,2528,2531,2534,2537,2540,2543,2546,2549,2552,2555,2558,2561,2564,2567,2570,2573,2576,2579,2582,2585,2588,2591,2594,2597,2600,2603,2606,2609,2612,2615,2618,2621],{"path":2078,"title":2079},"\u002Fabout","About Python CLI Toolcraft",{"path":2081,"title":2082},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":2084,"title":2085},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":2087,"title":2088},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":2090,"title":2091},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":2093,"title":2094},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":2096,"title":2097},"\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":2099,"title":2100},"\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":2102,"title":2103},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":2105,"title":2106},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":2108,"title":2109},"\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":2111,"title":2112},"\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":2114,"title":2115},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":2117,"title":2118},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":2120,"title":2121},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":2123,"title":2124},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":2126,"title":2127},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":2129,"title":2130},"\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":2132,"title":2133},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":2135,"title":2136},"\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":2138,"title":2139},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":2141,"title":2142},"\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":2144,"title":2145},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":2147,"title":2148},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":2150,"title":2151},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":2153,"title":2154},"\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":2156,"title":2157},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":2159,"title":2160},"\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":2162,"title":2163},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":2165,"title":2166},"\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":2168,"title":2169},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":2171,"title":2172},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":2174,"title":2175},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":2177,"title":2178},"\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":2180,"title":2181},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":2183,"title":2184},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":2186,"title":2187},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":2189,"title":2190},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":2192,"title":2193},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":2195,"title":2196},"\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":2198,"title":2199},"\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":2201,"title":2202},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":2204,"title":2205},"\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":2207,"title":2208},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":2210,"title":2211},"\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":2213,"title":2214},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":2216,"title":2217},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":2219,"title":2220},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":2222,"title":2223},"\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":2225,"title":2226},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":2228,"title":2229},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":2231,"title":2232},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":2234,"title":2235},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":2237,"title":2238},"\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":2240,"title":2241},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":2243,"title":2244},"\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":2246,"title":2247},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":2249,"title":2250},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":2252,"title":2253},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":2255,"title":2256},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":2258,"title":2259},"\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":2261,"title":2262},"\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":2264,"title":2265},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":2267,"title":2268},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":2270,"title":2271},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":2273,"title":2274},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":2276,"title":2277},"\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":2279,"title":2280},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":2282,"title":2283},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":2285,"title":2286},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":2288,"title":2289},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":2291,"title":2292},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":2294,"title":2295},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":2297,"title":2298},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":2300,"title":2301},"\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":2303,"title":2304},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":2306,"title":2307},"\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":2309,"title":2310},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":2312,"title":2313},"\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":2315,"title":2316},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":2318,"title":2319},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":2321,"title":2322},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":2324,"title":2325},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":2327,"title":2328},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":2330,"title":2331},"\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":2333,"title":2334},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":2336,"title":2337},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":2339,"title":2340},"\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":2342,"title":2343},"\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":2345,"title":2346},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":2348,"title":2349},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":2351,"title":2352},"\u002F","Python CLI Toolcraft",{"path":2354,"title":2355},"\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":2357,"title":2358},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":2360,"title":2361},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":2363,"title":2364},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":2366,"title":2367},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":2369,"title":2370},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":2372,"title":2373},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":2375,"title":2376},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":2378,"title":2379},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":2381,"title":2382},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":2384,"title":2385},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":2387,"title":2388},"\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":2390,"title":2391},"\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":2393,"title":2394},"\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":2396,"title":2397},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":2067,"title":5},{"path":2400,"title":2401},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":2403,"title":2404},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":2406,"title":2407},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":2409,"title":2410},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":2412,"title":2413},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":2415,"title":2416},"\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":2418,"title":2419},"\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":2421,"title":2422},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":2424,"title":2425},"\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":2427,"title":2428},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":2430,"title":2431},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":2433,"title":2434},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":2436,"title":2437},"\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":2439,"title":2440},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":2442,"title":2443},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":2445,"title":2446},"\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":2448,"title":2449},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":2451,"title":2452},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":2454,"title":2455},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":2457,"title":2458},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":2460,"title":2461},"\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":2463,"title":2464},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":2466,"title":2467},"\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":2469,"title":2470},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":2472,"title":2473},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":2475,"title":2476},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":2478,"title":2479},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":2481,"title":2482},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":2484,"title":2485},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":2487,"title":2488},"\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":2490,"title":2491},"\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":2493,"title":2494},"\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":2496,"title":2497},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":2499,"title":2500},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":2502,"title":2503},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":2505,"title":2506},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":2508,"title":2509},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":2511,"title":2512},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":2514,"title":2515},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":2517,"title":2518},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":2520,"title":2521},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":2523,"title":2524},"\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":2526,"title":2527},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":2529,"title":2530},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":2532,"title":2533},"\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":2535,"title":2536},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":2538,"title":2539},"\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":2541,"title":2542},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":2544,"title":2545},"\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":2547,"title":2548},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":2550,"title":2551},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":2553,"title":2554},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":2556,"title":2557},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":2559,"title":2560},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":2562,"title":2563},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":2565,"title":2566},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":2568,"title":2569},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":2571,"title":2572},"\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":2574,"title":2575},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":2577,"title":2578},"\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":2580,"title":2581},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":2583,"title":2584},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":2586,"title":2587},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":2589,"title":2590},"\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":2592,"title":2593},"\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":2595,"title":2596},"\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":2598,"title":2599},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":2601,"title":2602},"\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":2604,"title":2605},"\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":2607,"title":2608},"\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":2610,"title":2611},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":2613,"title":2614},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":2616,"title":2617},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":2619,"title":2620},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":2622,"title":2623},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1789736907245]