[{"data":1,"prerenderedAt":2826},["ShallowReactive",2],{"page-\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fdid-you-mean-suggestions-for-mistyped-input\u002F":3,"content-directory":1981},{"id":4,"title":5,"body":6,"date":1967,"description":1968,"difficulty":1969,"draft":1970,"extension":1971,"meta":1972,"navigation":172,"path":1973,"seo":1974,"stem":1975,"tags":1976,"updated":1967,"__hash__":1980},"content\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fdid-you-mean-suggestions-for-mistyped-input\u002Findex.md","Did You Mean…? Suggestions for Mistyped CLI Input",{"type":7,"value":8,"toc":1945},"minimark",[9,55,60,74,78,82,85,95,114,118,133,447,470,475,478,717,723,733,737,744,924,930,945,948,952,959,1090,1096,1099,1103,1106,1353,1368,1372,1435,1438,1442,1445,1811,1814,1818,1827,1831,1838,1844,1848,1858,1862,1869,1873,1896,1900,1906,1910,1941],[10,11,12,13,17,18,21,22,17,25,21,28,31,32,35,36,40,41,44,45,48,49,54],"p",{},"Typos are the most common error a CLI sees: ",[14,15,16],"code",{},"stauts"," for ",[14,19,20],{},"status",", ",[14,23,24],{},"--forse",[14,26,27],{},"--force",[14,29,30],{},"--env stagign",", a service called ",[14,33,34],{},"api-gatway",". The difference between a frustrating tool and a friendly one is often a single sentence at the end of the error — ",[37,38,39],"em",{},"Did you mean 'staging'?"," — which turns a dead end into a one-key fix. Modern frameworks already provide this for commands and options; the gaps are option ",[37,42,43],{},"values",", names of things your tool manages (services, projects, profiles), and commands you renamed between releases. This guide shows what you get for free, then fills those gaps with a small helper built on the standard library's ",[14,46,47],{},"difflib",", a choice type that suggests, and aliases that keep old command names working. It belongs to the ",[50,51,53],"a",{"href":52},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002F","error handling topic",".",[56,57,59],"h2",{"id":58},"prerequisites","Prerequisites",[61,62,63,67],"ul",{},[64,65,66],"li",{},"Click 8.x or Typer (examples checked with Click 8.5 and Typer 0.27); argparse on Python 3.14 for its equivalent.",[64,68,69,70,54],{},"The error conventions from ",[50,71,73],{"href":72},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks\u002F","friendly error messages and tracebacks",[56,75,77],{"id":76},"what-you-already-get","What you already get",[79,80],"inline-diagram",{"name":81},"dym-coverage",[10,83,84],{},"Current Click suggests close matches for unknown commands and options:",[86,87,93],"pre",{"className":88,"code":90,"language":91,"meta":92},[89],"language-text","Error: No such command 'stauts'. (Did you mean one of: 'start', 'status'?)\nError: No such option '--forse'. (Did you mean one of: '--force', '--format'?)\n","text","",[14,94,90],{"__ignoreMap":92},[10,96,97,98,101,102,106,107,110,111,113],{},"Typer renders the same idea in its error panel (\"No such command 'stauts'. Did you mean 'status', 'start'?\"), and Python 3.14's argparse adds suggestions for invalid choices when ",[14,99,100],{},"suggest_on_error"," is enabled, as shown in ",[50,103,105],{"href":104},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargument-groups-and-help-formatting-in-argparse\u002F","argument groups and help formatting in argparse",". What none of them can do is suggest ",[37,108,109],{},"data",": a mistyped service name only your API knows about, or a choice value in Click, where ",[14,112,30],{}," produces \"is not one of 'dev', 'staging', 'production'\" without pointing at the obvious fix.",[56,115,117],{"id":116},"the-recipe","The recipe",[10,119,120,121,124,125,128,129,132],{},"A small helper combines two kinds of match: candidates that ",[37,122,123],{},"start with"," what the user typed (catching abbreviations like ",[14,126,127],{},"prod","), and close matches by similarity (catching transpositions like ",[14,130,131],{},"stagign","):",[86,134,138],{"className":135,"code":136,"language":137,"meta":92,"style":92},"language-python shiki shiki-themes github-light github-dark","# src\u002Fmytool\u002Fsuggest.py\nfrom __future__ import annotations\n\nimport difflib\n\n\ndef suggest(value: str, candidates: list[str], *, n: int = 3, cutoff: float = 0.6) -> list[str]:\n    prefixed = [c for c in candidates if c.startswith(value) and c != value]\n    close = difflib.get_close_matches(value, candidates, n=n, cutoff=cutoff)\n    return list(dict.fromkeys(prefixed + close))[:n]          # ordered, de-duplicated\n\n\ndef did_you_mean(value: str, candidates: list[str]) -> str:\n    matches = suggest(value, candidates)\n    return f\" Did you mean {', '.join(repr(m) for m in matches)}?\" if matches else \"\"\n","python",[14,139,140,149,167,174,183,188,193,251,292,320,347,352,357,381,392],{"__ignoreMap":92},[141,142,145],"span",{"class":143,"line":144},"line",1,[141,146,148],{"class":147},"sJ8bj","# src\u002Fmytool\u002Fsuggest.py\n",[141,150,152,156,160,163],{"class":143,"line":151},2,[141,153,155],{"class":154},"szBVR","from",[141,157,159],{"class":158},"sj4cs"," __future__",[141,161,162],{"class":154}," import",[141,164,166],{"class":165},"sVt8B"," annotations\n",[141,168,170],{"class":143,"line":169},3,[141,171,173],{"emptyLinePlaceholder":172},true,"\n",[141,175,177,180],{"class":143,"line":176},4,[141,178,179],{"class":154},"import",[141,181,182],{"class":165}," difflib\n",[141,184,186],{"class":143,"line":185},5,[141,187,173],{"emptyLinePlaceholder":172},[141,189,191],{"class":143,"line":190},6,[141,192,173],{"emptyLinePlaceholder":172},[141,194,196,199,203,206,209,212,214,217,220,223,226,229,232,235,238,240,243,246,248],{"class":143,"line":195},7,[141,197,198],{"class":154},"def",[141,200,202],{"class":201},"sScJk"," suggest",[141,204,205],{"class":165},"(value: ",[141,207,208],{"class":158},"str",[141,210,211],{"class":165},", candidates: list[",[141,213,208],{"class":158},[141,215,216],{"class":165},"], ",[141,218,219],{"class":154},"*",[141,221,222],{"class":165},", n: ",[141,224,225],{"class":158},"int",[141,227,228],{"class":154}," =",[141,230,231],{"class":158}," 3",[141,233,234],{"class":165},", cutoff: ",[141,236,237],{"class":158},"float",[141,239,228],{"class":154},[141,241,242],{"class":158}," 0.6",[141,244,245],{"class":165},") -> list[",[141,247,208],{"class":158},[141,249,250],{"class":165},"]:\n",[141,252,254,257,260,263,266,269,272,275,278,281,284,286,289],{"class":143,"line":253},8,[141,255,256],{"class":165},"    prefixed ",[141,258,259],{"class":154},"=",[141,261,262],{"class":165}," [c ",[141,264,265],{"class":154},"for",[141,267,268],{"class":165}," c ",[141,270,271],{"class":154},"in",[141,273,274],{"class":165}," candidates ",[141,276,277],{"class":154},"if",[141,279,280],{"class":165}," c.startswith(value) ",[141,282,283],{"class":154},"and",[141,285,268],{"class":165},[141,287,288],{"class":154},"!=",[141,290,291],{"class":165}," value]\n",[141,293,295,298,300,303,307,309,312,315,317],{"class":143,"line":294},9,[141,296,297],{"class":165},"    close ",[141,299,259],{"class":154},[141,301,302],{"class":165}," difflib.get_close_matches(value, candidates, ",[141,304,306],{"class":305},"s4XuR","n",[141,308,259],{"class":154},[141,310,311],{"class":165},"n, ",[141,313,314],{"class":305},"cutoff",[141,316,259],{"class":154},[141,318,319],{"class":165},"cutoff)\n",[141,321,323,326,329,332,335,338,341,344],{"class":143,"line":322},10,[141,324,325],{"class":154},"    return",[141,327,328],{"class":158}," list",[141,330,331],{"class":165},"(",[141,333,334],{"class":158},"dict",[141,336,337],{"class":165},".fromkeys(prefixed ",[141,339,340],{"class":154},"+",[141,342,343],{"class":165}," close))[:n]          ",[141,345,346],{"class":147},"# ordered, de-duplicated\n",[141,348,350],{"class":143,"line":349},11,[141,351,173],{"emptyLinePlaceholder":172},[141,353,355],{"class":143,"line":354},12,[141,356,173],{"emptyLinePlaceholder":172},[141,358,360,362,365,367,369,371,373,376,378],{"class":143,"line":359},13,[141,361,198],{"class":154},[141,363,364],{"class":201}," did_you_mean",[141,366,205],{"class":165},[141,368,208],{"class":158},[141,370,211],{"class":165},[141,372,208],{"class":158},[141,374,375],{"class":165},"]) -> ",[141,377,208],{"class":158},[141,379,380],{"class":165},":\n",[141,382,384,387,389],{"class":143,"line":383},14,[141,385,386],{"class":165},"    matches ",[141,388,259],{"class":154},[141,390,391],{"class":165}," suggest(value, candidates)\n",[141,393,395,397,400,404,407,410,413,416,419,421,424,426,429,432,435,438,441,444],{"class":143,"line":394},15,[141,396,325],{"class":154},[141,398,399],{"class":154}," f",[141,401,403],{"class":402},"sZZnC","\" Did you mean ",[141,405,406],{"class":158},"{",[141,408,409],{"class":402},"', '",[141,411,412],{"class":165},".join(",[141,414,415],{"class":158},"repr",[141,417,418],{"class":165},"(m) ",[141,420,265],{"class":154},[141,422,423],{"class":165}," m ",[141,425,271],{"class":154},[141,427,428],{"class":165}," matches)",[141,430,431],{"class":158},"}",[141,433,434],{"class":402},"?\"",[141,436,437],{"class":154}," if",[141,439,440],{"class":165}," matches ",[141,442,443],{"class":154},"else",[141,445,446],{"class":402}," \"\"\n",[10,448,449,452,453,455,456,458,459,462,463,465,466,469],{},[14,450,451],{},"difflib.get_close_matches"," scores candidates by a similarity ratio and returns the best above ",[14,454,314],{},". Its default of 0.6 is a good balance: ",[14,457,131],{}," scores well against ",[14,460,461],{},"staging",", unrelated words do not. The prefix pass covers what similarity alone misses — ",[14,464,127],{}," versus ",[14,467,468],{},"production"," scores below the cutoff, but it is obviously an abbreviation.",[471,472,474],"h3",{"id":473},"suggestions-for-resource-names","Suggestions for resource names",[10,476,477],{},"The most valuable place for suggestions is where the framework cannot help: names of things your tool manages.",[86,479,481],{"className":135,"code":480,"language":137,"meta":92,"style":92},"# src\u002Fmytool\u002Fcli.py\nimport click\n\nfrom mytool.suggest import did_you_mean\n\nSERVICES = [\"api-gateway\", \"billing\", \"search-indexer\", \"web\"]\n\n\n@click.group()\ndef cli() -> None:\n    \"\"\"Ops tool.\"\"\"\n\n\n@cli.command()\n@click.argument(\"service\")\ndef restart(service: str) -> None:\n    \"\"\"Restart SERVICE.\"\"\"\n    if service not in SERVICES:\n        raise click.ClickException(f\"unknown service {service!r}.\" + did_you_mean(service, SERVICES))\n    click.echo(f\"restarting {service}\")\n",[14,482,483,488,495,499,511,515,546,550,554,562,577,582,586,590,597,610,630,636,656,695],{"__ignoreMap":92},[141,484,485],{"class":143,"line":144},[141,486,487],{"class":147},"# src\u002Fmytool\u002Fcli.py\n",[141,489,490,492],{"class":143,"line":151},[141,491,179],{"class":154},[141,493,494],{"class":165}," click\n",[141,496,497],{"class":143,"line":169},[141,498,173],{"emptyLinePlaceholder":172},[141,500,501,503,506,508],{"class":143,"line":176},[141,502,155],{"class":154},[141,504,505],{"class":165}," mytool.suggest ",[141,507,179],{"class":154},[141,509,510],{"class":165}," did_you_mean\n",[141,512,513],{"class":143,"line":185},[141,514,173],{"emptyLinePlaceholder":172},[141,516,517,520,522,525,528,530,533,535,538,540,543],{"class":143,"line":190},[141,518,519],{"class":158},"SERVICES",[141,521,228],{"class":154},[141,523,524],{"class":165}," [",[141,526,527],{"class":402},"\"api-gateway\"",[141,529,21],{"class":165},[141,531,532],{"class":402},"\"billing\"",[141,534,21],{"class":165},[141,536,537],{"class":402},"\"search-indexer\"",[141,539,21],{"class":165},[141,541,542],{"class":402},"\"web\"",[141,544,545],{"class":165},"]\n",[141,547,548],{"class":143,"line":195},[141,549,173],{"emptyLinePlaceholder":172},[141,551,552],{"class":143,"line":253},[141,553,173],{"emptyLinePlaceholder":172},[141,555,556,559],{"class":143,"line":294},[141,557,558],{"class":201},"@click.group",[141,560,561],{"class":165},"()\n",[141,563,564,566,569,572,575],{"class":143,"line":322},[141,565,198],{"class":154},[141,567,568],{"class":201}," cli",[141,570,571],{"class":165},"() -> ",[141,573,574],{"class":158},"None",[141,576,380],{"class":165},[141,578,579],{"class":143,"line":349},[141,580,581],{"class":402},"    \"\"\"Ops tool.\"\"\"\n",[141,583,584],{"class":143,"line":354},[141,585,173],{"emptyLinePlaceholder":172},[141,587,588],{"class":143,"line":359},[141,589,173],{"emptyLinePlaceholder":172},[141,591,592,595],{"class":143,"line":383},[141,593,594],{"class":201},"@cli.command",[141,596,561],{"class":165},[141,598,599,602,604,607],{"class":143,"line":394},[141,600,601],{"class":201},"@click.argument",[141,603,331],{"class":165},[141,605,606],{"class":402},"\"service\"",[141,608,609],{"class":165},")\n",[141,611,613,615,618,621,623,626,628],{"class":143,"line":612},16,[141,614,198],{"class":154},[141,616,617],{"class":201}," restart",[141,619,620],{"class":165},"(service: ",[141,622,208],{"class":158},[141,624,625],{"class":165},") -> ",[141,627,574],{"class":158},[141,629,380],{"class":165},[141,631,633],{"class":143,"line":632},17,[141,634,635],{"class":402},"    \"\"\"Restart SERVICE.\"\"\"\n",[141,637,639,642,645,648,651,654],{"class":143,"line":638},18,[141,640,641],{"class":154},"    if",[141,643,644],{"class":165}," service ",[141,646,647],{"class":154},"not",[141,649,650],{"class":154}," in",[141,652,653],{"class":158}," SERVICES",[141,655,380],{"class":165},[141,657,659,662,665,668,671,673,676,679,681,684,687,690,692],{"class":143,"line":658},19,[141,660,661],{"class":154},"        raise",[141,663,664],{"class":165}," click.ClickException(",[141,666,667],{"class":154},"f",[141,669,670],{"class":402},"\"unknown service ",[141,672,406],{"class":158},[141,674,675],{"class":165},"service",[141,677,678],{"class":154},"!r",[141,680,431],{"class":158},[141,682,683],{"class":402},".\"",[141,685,686],{"class":154}," +",[141,688,689],{"class":165}," did_you_mean(service, ",[141,691,519],{"class":158},[141,693,694],{"class":165},"))\n",[141,696,698,701,703,706,708,710,712,715],{"class":143,"line":697},20,[141,699,700],{"class":165},"    click.echo(",[141,702,667],{"class":154},[141,704,705],{"class":402},"\"restarting ",[141,707,406],{"class":158},[141,709,675],{"class":165},[141,711,431],{"class":158},[141,713,714],{"class":402},"\"",[141,716,609],{"class":165},[86,718,721],{"className":719,"code":720,"language":91,"meta":92},[89],"$ mytool restart api-gatway\nError: unknown service 'api-gatway'. Did you mean 'api-gateway'?\n",[14,722,720],{"__ignoreMap":92},[10,724,725,726,728,729,54],{},"In a real tool, ",[14,727,519],{}," comes from the API — and the list is often already fetched to perform the lookup, so the suggestion costs nothing extra. Where it would require an extra slow call, use cached names, as in ",[50,730,732],{"href":731},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis\u002Fcaching-http-responses-on-disk-in-a-cli\u002F","caching HTTP responses on disk in a CLI",[471,734,736],{"id":735},"a-choice-type-that-suggests","A choice type that suggests",[10,738,739,740,743],{},"For Click choices, subclass ",[14,741,742],{},"click.Choice"," and add the suggestion to the failure message:",[86,745,747],{"className":135,"code":746,"language":137,"meta":92,"style":92},"# src\u002Fmytool\u002Ftypes.py\nimport click\n\nfrom mytool.suggest import did_you_mean\n\n\nclass SuggestingChoice(click.Choice):\n    def convert(self, value, param, ctx):\n        try:\n            return super().convert(value, param, ctx)\n        except click.BadParameter:\n            choices = [str(c) for c in self.choices]\n            self.fail(f\"{value!r} is not one of {', '.join(map(repr, choices))}.\"\n                      + did_you_mean(str(value), choices), param, ctx)\n",[14,748,749,754,760,764,774,778,782,803,814,821,832,840,866,911],{"__ignoreMap":92},[141,750,751],{"class":143,"line":144},[141,752,753],{"class":147},"# src\u002Fmytool\u002Ftypes.py\n",[141,755,756,758],{"class":143,"line":151},[141,757,179],{"class":154},[141,759,494],{"class":165},[141,761,762],{"class":143,"line":169},[141,763,173],{"emptyLinePlaceholder":172},[141,765,766,768,770,772],{"class":143,"line":176},[141,767,155],{"class":154},[141,769,505],{"class":165},[141,771,179],{"class":154},[141,773,510],{"class":165},[141,775,776],{"class":143,"line":185},[141,777,173],{"emptyLinePlaceholder":172},[141,779,780],{"class":143,"line":190},[141,781,173],{"emptyLinePlaceholder":172},[141,783,784,787,790,792,795,797,800],{"class":143,"line":195},[141,785,786],{"class":154},"class",[141,788,789],{"class":201}," SuggestingChoice",[141,791,331],{"class":165},[141,793,794],{"class":201},"click",[141,796,54],{"class":165},[141,798,799],{"class":201},"Choice",[141,801,802],{"class":165},"):\n",[141,804,805,808,811],{"class":143,"line":253},[141,806,807],{"class":154},"    def",[141,809,810],{"class":201}," convert",[141,812,813],{"class":165},"(self, value, param, ctx):\n",[141,815,816,819],{"class":143,"line":294},[141,817,818],{"class":154},"        try",[141,820,380],{"class":165},[141,822,823,826,829],{"class":143,"line":322},[141,824,825],{"class":154},"            return",[141,827,828],{"class":158}," super",[141,830,831],{"class":165},"().convert(value, param, ctx)\n",[141,833,834,837],{"class":143,"line":349},[141,835,836],{"class":154},"        except",[141,838,839],{"class":165}," click.BadParameter:\n",[141,841,842,845,847,849,851,854,856,858,860,863],{"class":143,"line":354},[141,843,844],{"class":165},"            choices ",[141,846,259],{"class":154},[141,848,524],{"class":165},[141,850,208],{"class":158},[141,852,853],{"class":165},"(c) ",[141,855,265],{"class":154},[141,857,268],{"class":165},[141,859,271],{"class":154},[141,861,862],{"class":158}," self",[141,864,865],{"class":165},".choices]\n",[141,867,868,871,874,876,878,880,883,885,887,890,892,894,896,899,901,903,906,908],{"class":143,"line":359},[141,869,870],{"class":158},"            self",[141,872,873],{"class":165},".fail(",[141,875,667],{"class":154},[141,877,714],{"class":402},[141,879,406],{"class":158},[141,881,882],{"class":165},"value",[141,884,678],{"class":154},[141,886,431],{"class":158},[141,888,889],{"class":402}," is not one of ",[141,891,406],{"class":158},[141,893,409],{"class":402},[141,895,412],{"class":165},[141,897,898],{"class":158},"map",[141,900,331],{"class":165},[141,902,415],{"class":158},[141,904,905],{"class":165},", choices))",[141,907,431],{"class":158},[141,909,910],{"class":402},".\"\n",[141,912,913,916,919,921],{"class":143,"line":383},[141,914,915],{"class":154},"                      +",[141,917,918],{"class":165}," did_you_mean(",[141,920,208],{"class":158},[141,922,923],{"class":165},"(value), choices), param, ctx)\n",[86,925,928],{"className":926,"code":927,"language":91,"meta":92},[89],"Error: Invalid value for '--env': 'stagign' is not one of 'dev', 'staging', 'production'. Did you mean 'staging'?\n",[14,929,927],{"__ignoreMap":92},[10,931,932,933,935,936,939,940,944],{},"Use it exactly like ",[14,934,742],{},": ",[14,937,938],{},"@click.option(\"--env\", type=SuggestingChoice([\"dev\", \"staging\", \"production\"]))",". ",[50,941,943],{"href":942},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types\u002F","Writing custom Click parameter types"," covers the type API in general.",[79,946],{"name":947},"dym-terminal",[471,949,951],{"id":950},"suggestions-for-missing-files","Suggestions for missing files",[10,953,954,955,958],{},"A missing file is a typo more often than a missing file. Listing the parent directory and suggesting close names turns ",[14,956,957],{},"No such file"," into a fix:",[86,960,962],{"className":135,"code":961,"language":137,"meta":92,"style":92},"from pathlib import Path\n\nfrom mytool.suggest import did_you_mean\n\n\ndef missing_file_message(path: Path) -> str:\n    parent = path.parent if path.parent.is_dir() else Path(\".\")\n    siblings = [p.name for p in parent.iterdir()] if parent.is_dir() else []\n    return f\"{path} does not exist.\" + did_you_mean(path.name, siblings)\n",[14,963,964,976,980,990,994,998,1012,1037,1067],{"__ignoreMap":92},[141,965,966,968,971,973],{"class":143,"line":144},[141,967,155],{"class":154},[141,969,970],{"class":165}," pathlib ",[141,972,179],{"class":154},[141,974,975],{"class":165}," Path\n",[141,977,978],{"class":143,"line":151},[141,979,173],{"emptyLinePlaceholder":172},[141,981,982,984,986,988],{"class":143,"line":169},[141,983,155],{"class":154},[141,985,505],{"class":165},[141,987,179],{"class":154},[141,989,510],{"class":165},[141,991,992],{"class":143,"line":176},[141,993,173],{"emptyLinePlaceholder":172},[141,995,996],{"class":143,"line":185},[141,997,173],{"emptyLinePlaceholder":172},[141,999,1000,1002,1005,1008,1010],{"class":143,"line":190},[141,1001,198],{"class":154},[141,1003,1004],{"class":201}," missing_file_message",[141,1006,1007],{"class":165},"(path: Path) -> ",[141,1009,208],{"class":158},[141,1011,380],{"class":165},[141,1013,1014,1017,1019,1022,1024,1027,1029,1032,1035],{"class":143,"line":195},[141,1015,1016],{"class":165},"    parent ",[141,1018,259],{"class":154},[141,1020,1021],{"class":165}," path.parent ",[141,1023,277],{"class":154},[141,1025,1026],{"class":165}," path.parent.is_dir() ",[141,1028,443],{"class":154},[141,1030,1031],{"class":165}," Path(",[141,1033,1034],{"class":402},"\".\"",[141,1036,609],{"class":165},[141,1038,1039,1042,1044,1047,1049,1052,1054,1057,1059,1062,1064],{"class":143,"line":253},[141,1040,1041],{"class":165},"    siblings ",[141,1043,259],{"class":154},[141,1045,1046],{"class":165}," [p.name ",[141,1048,265],{"class":154},[141,1050,1051],{"class":165}," p ",[141,1053,271],{"class":154},[141,1055,1056],{"class":165}," parent.iterdir()] ",[141,1058,277],{"class":154},[141,1060,1061],{"class":165}," parent.is_dir() ",[141,1063,443],{"class":154},[141,1065,1066],{"class":165}," []\n",[141,1068,1069,1071,1073,1075,1077,1080,1082,1085,1087],{"class":143,"line":294},[141,1070,325],{"class":154},[141,1072,399],{"class":154},[141,1074,714],{"class":402},[141,1076,406],{"class":158},[141,1078,1079],{"class":165},"path",[141,1081,431],{"class":158},[141,1083,1084],{"class":402}," does not exist.\"",[141,1086,686],{"class":154},[141,1088,1089],{"class":165}," did_you_mean(path.name, siblings)\n",[86,1091,1094],{"className":1092,"code":1093,"language":91,"meta":92},[89],"d\u002Fconfg.toml does not exist. Did you mean 'config.toml', 'conf.d'?\n",[14,1095,1093],{"__ignoreMap":92},[10,1097,1098],{},"Only do this for directories of reasonable size — a directory with a hundred thousand entries makes the error slow — and never for paths outside what the user asked about.",[471,1100,1102],{"id":1101},"aliases-for-renamed-commands","Aliases for renamed commands",[10,1104,1105],{},"When you rename a command, old muscle memory and old scripts keep using the previous name. A suggestion helps people; an alias helps scripts too. A Click group can map old names to new ones with a deprecation warning:",[86,1107,1109],{"className":135,"code":1108,"language":137,"meta":92,"style":92},"class AliasedGroup(click.Group):\n    \"\"\"Accept renamed commands with a warning.\"\"\"\n\n    RENAMED = {\"ls\": \"list\", \"rm\": \"remove\", \"info\": \"status\"}\n\n    def get_command(self, ctx, cmd_name):\n        cmd = super().get_command(ctx, cmd_name)\n        if cmd is None and cmd_name in self.RENAMED:\n            new = self.RENAMED[cmd_name]\n            click.echo(f\"warning: '{cmd_name}' is now '{new}'\", err=True)\n            return super().get_command(ctx, new)\n        return cmd\n\n    def resolve_command(self, ctx, args):\n        name, cmd, rest = super().resolve_command(ctx, args)\n        return (cmd.name if cmd else name), cmd, rest\n",[14,1110,1111,1129,1134,1138,1179,1183,1193,1205,1236,1252,1294,1303,1311,1315,1325,1337],{"__ignoreMap":92},[141,1112,1113,1115,1118,1120,1122,1124,1127],{"class":143,"line":144},[141,1114,786],{"class":154},[141,1116,1117],{"class":201}," AliasedGroup",[141,1119,331],{"class":165},[141,1121,794],{"class":201},[141,1123,54],{"class":165},[141,1125,1126],{"class":201},"Group",[141,1128,802],{"class":165},[141,1130,1131],{"class":143,"line":151},[141,1132,1133],{"class":402},"    \"\"\"Accept renamed commands with a warning.\"\"\"\n",[141,1135,1136],{"class":143,"line":169},[141,1137,173],{"emptyLinePlaceholder":172},[141,1139,1140,1143,1145,1148,1151,1153,1156,1158,1161,1163,1166,1168,1171,1173,1176],{"class":143,"line":176},[141,1141,1142],{"class":158},"    RENAMED",[141,1144,228],{"class":154},[141,1146,1147],{"class":165}," {",[141,1149,1150],{"class":402},"\"ls\"",[141,1152,935],{"class":165},[141,1154,1155],{"class":402},"\"list\"",[141,1157,21],{"class":165},[141,1159,1160],{"class":402},"\"rm\"",[141,1162,935],{"class":165},[141,1164,1165],{"class":402},"\"remove\"",[141,1167,21],{"class":165},[141,1169,1170],{"class":402},"\"info\"",[141,1172,935],{"class":165},[141,1174,1175],{"class":402},"\"status\"",[141,1177,1178],{"class":165},"}\n",[141,1180,1181],{"class":143,"line":185},[141,1182,173],{"emptyLinePlaceholder":172},[141,1184,1185,1187,1190],{"class":143,"line":190},[141,1186,807],{"class":154},[141,1188,1189],{"class":201}," get_command",[141,1191,1192],{"class":165},"(self, ctx, cmd_name):\n",[141,1194,1195,1198,1200,1202],{"class":143,"line":195},[141,1196,1197],{"class":165},"        cmd ",[141,1199,259],{"class":154},[141,1201,828],{"class":158},[141,1203,1204],{"class":165},"().get_command(ctx, cmd_name)\n",[141,1206,1207,1210,1213,1216,1219,1222,1225,1227,1229,1231,1234],{"class":143,"line":253},[141,1208,1209],{"class":154},"        if",[141,1211,1212],{"class":165}," cmd ",[141,1214,1215],{"class":154},"is",[141,1217,1218],{"class":158}," None",[141,1220,1221],{"class":154}," and",[141,1223,1224],{"class":165}," cmd_name ",[141,1226,271],{"class":154},[141,1228,862],{"class":158},[141,1230,54],{"class":165},[141,1232,1233],{"class":158},"RENAMED",[141,1235,380],{"class":165},[141,1237,1238,1241,1243,1245,1247,1249],{"class":143,"line":294},[141,1239,1240],{"class":165},"            new ",[141,1242,259],{"class":154},[141,1244,862],{"class":158},[141,1246,54],{"class":165},[141,1248,1233],{"class":158},[141,1250,1251],{"class":165},"[cmd_name]\n",[141,1253,1254,1257,1259,1262,1264,1267,1269,1272,1274,1277,1279,1282,1284,1287,1289,1292],{"class":143,"line":322},[141,1255,1256],{"class":165},"            click.echo(",[141,1258,667],{"class":154},[141,1260,1261],{"class":402},"\"warning: '",[141,1263,406],{"class":158},[141,1265,1266],{"class":165},"cmd_name",[141,1268,431],{"class":158},[141,1270,1271],{"class":402},"' is now '",[141,1273,406],{"class":158},[141,1275,1276],{"class":165},"new",[141,1278,431],{"class":158},[141,1280,1281],{"class":402},"'\"",[141,1283,21],{"class":165},[141,1285,1286],{"class":305},"err",[141,1288,259],{"class":154},[141,1290,1291],{"class":158},"True",[141,1293,609],{"class":165},[141,1295,1296,1298,1300],{"class":143,"line":349},[141,1297,825],{"class":154},[141,1299,828],{"class":158},[141,1301,1302],{"class":165},"().get_command(ctx, new)\n",[141,1304,1305,1308],{"class":143,"line":354},[141,1306,1307],{"class":154},"        return",[141,1309,1310],{"class":165}," cmd\n",[141,1312,1313],{"class":143,"line":359},[141,1314,173],{"emptyLinePlaceholder":172},[141,1316,1317,1319,1322],{"class":143,"line":383},[141,1318,807],{"class":154},[141,1320,1321],{"class":201}," resolve_command",[141,1323,1324],{"class":165},"(self, ctx, args):\n",[141,1326,1327,1330,1332,1334],{"class":143,"line":394},[141,1328,1329],{"class":165},"        name, cmd, rest ",[141,1331,259],{"class":154},[141,1333,828],{"class":158},[141,1335,1336],{"class":165},"().resolve_command(ctx, args)\n",[141,1338,1339,1341,1344,1346,1348,1350],{"class":143,"line":612},[141,1340,1307],{"class":154},[141,1342,1343],{"class":165}," (cmd.name ",[141,1345,277],{"class":154},[141,1347,1212],{"class":165},[141,1349,443],{"class":154},[141,1351,1352],{"class":165}," name), cmd, rest\n",[10,1354,1355,1356,1359,1360,1363,1364,54],{},"Pass ",[14,1357,1358],{},"cls=AliasedGroup"," to ",[14,1361,1362],{},"@click.group()",". The warning goes to stderr so scripts keep working while their authors are nudged towards the new name. Remove aliases in a later major release, following the policy in ",[50,1365,1367],{"href":1366},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags\u002F","versioning and deprecating CLI flags",[56,1369,1371],{"id":1370},"ux-considerations","UX considerations",[61,1373,1374,1396,1402,1408,1421],{},[64,1375,1376,1380,1381,1384,1385,1387,1388,1391,1392,1395],{},[1377,1378,1379],"strong",{},"Suggest, never auto-correct."," Running ",[14,1382,1383],{},"restart api-gateway"," when the user typed ",[14,1386,34],{}," is fine; running ",[14,1389,1390],{},"delete prod-db"," when they typed ",[14,1393,1394],{},"delete prod-dv"," is not. Suggestions keep the human in the loop.",[64,1397,1398,1401],{},[1377,1399,1400],{},"Keep suggestions short."," One to three candidates; a list of ten is just a less readable help screen.",[64,1403,1404,1407],{},[1377,1405,1406],{},"Put the suggestion at the end of the error,"," where the eye lands, and keep the exit code unchanged (2 for usage errors, your own code for lookup failures).",[64,1409,1410,1413,1414,1417,1418,1420],{},[1377,1411,1412],{},"Avoid unique-prefix execution"," for anything destructive. Some tools run a command when a prefix is unambiguous (",[14,1415,1416],{},"mytool sta"," → ",[14,1419,20],{},"); that silently changes meaning when a new command with the same prefix is added.",[64,1422,1423,1426,1427,1430,1431,54],{},[1377,1424,1425],{},"Suggest in JSON mode too,"," as a field such as ",[14,1428,1429],{},"\"suggestions\": [\"staging\"]"," in the machine-readable error from ",[50,1432,1434],{"href":1433},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Freporting-machine-readable-errors-in-json-mode\u002F","reporting machine-readable errors in JSON mode",[79,1436],{"name":1437},"dym-matching",[56,1439,1441],{"id":1440},"testing-the-behaviour","Testing the behaviour",[10,1443,1444],{},"Test the helper with a table of real typos, and the commands for the messages users see:",[86,1446,1448],{"className":135,"code":1447,"language":137,"meta":92,"style":92},"# tests\u002Ftest_suggest.py\nimport click\nimport pytest\nfrom click.testing import CliRunner\n\nfrom mytool.cli import cli\nfrom mytool.suggest import suggest\nfrom mytool.types import SuggestingChoice\n\n\n@pytest.mark.parametrize(\"typed,expected\", [\n    (\"stagign\", [\"staging\"]), (\"prod\", [\"production\"]), (\"dve\", [\"dev\"]), (\"xyz\", []),\n])\ndef test_suggest(typed, expected):\n    assert suggest(typed, [\"dev\", \"staging\", \"production\"]) == expected\n\n\ndef test_unknown_service_suggests():\n    result = CliRunner().invoke(cli, [\"restart\", \"api-gatway\"])\n    assert result.exit_code == 1\n    assert \"Did you mean 'api-gateway'?\" in result.output\n\n\ndef test_choice_suggests():\n    @click.command()\n    @click.option(\"--env\", type=SuggestingChoice([\"dev\", \"staging\", \"production\"]))\n    def deploy(env):\n        click.echo(env)\n\n    result = CliRunner().invoke(deploy, [\"--env\", \"stagign\"])\n    assert result.exit_code == 2 and \"Did you mean 'staging'?\" in result.output\n",[14,1449,1450,1455,1461,1468,1480,1484,1496,1507,1519,1523,1527,1540,1583,1588,1598,1625,1629,1633,1643,1663,1675,1688,1693,1698,1708,1716,1750,1761,1767,1772,1790],{"__ignoreMap":92},[141,1451,1452],{"class":143,"line":144},[141,1453,1454],{"class":147},"# tests\u002Ftest_suggest.py\n",[141,1456,1457,1459],{"class":143,"line":151},[141,1458,179],{"class":154},[141,1460,494],{"class":165},[141,1462,1463,1465],{"class":143,"line":169},[141,1464,179],{"class":154},[141,1466,1467],{"class":165}," pytest\n",[141,1469,1470,1472,1475,1477],{"class":143,"line":176},[141,1471,155],{"class":154},[141,1473,1474],{"class":165}," click.testing ",[141,1476,179],{"class":154},[141,1478,1479],{"class":165}," CliRunner\n",[141,1481,1482],{"class":143,"line":185},[141,1483,173],{"emptyLinePlaceholder":172},[141,1485,1486,1488,1491,1493],{"class":143,"line":190},[141,1487,155],{"class":154},[141,1489,1490],{"class":165}," mytool.cli ",[141,1492,179],{"class":154},[141,1494,1495],{"class":165}," cli\n",[141,1497,1498,1500,1502,1504],{"class":143,"line":195},[141,1499,155],{"class":154},[141,1501,505],{"class":165},[141,1503,179],{"class":154},[141,1505,1506],{"class":165}," suggest\n",[141,1508,1509,1511,1514,1516],{"class":143,"line":253},[141,1510,155],{"class":154},[141,1512,1513],{"class":165}," mytool.types ",[141,1515,179],{"class":154},[141,1517,1518],{"class":165}," SuggestingChoice\n",[141,1520,1521],{"class":143,"line":294},[141,1522,173],{"emptyLinePlaceholder":172},[141,1524,1525],{"class":143,"line":322},[141,1526,173],{"emptyLinePlaceholder":172},[141,1528,1529,1532,1534,1537],{"class":143,"line":349},[141,1530,1531],{"class":201},"@pytest.mark.parametrize",[141,1533,331],{"class":165},[141,1535,1536],{"class":402},"\"typed,expected\"",[141,1538,1539],{"class":165},", [\n",[141,1541,1542,1545,1548,1551,1554,1557,1560,1562,1565,1567,1570,1572,1575,1577,1580],{"class":143,"line":354},[141,1543,1544],{"class":165},"    (",[141,1546,1547],{"class":402},"\"stagign\"",[141,1549,1550],{"class":165},", [",[141,1552,1553],{"class":402},"\"staging\"",[141,1555,1556],{"class":165},"]), (",[141,1558,1559],{"class":402},"\"prod\"",[141,1561,1550],{"class":165},[141,1563,1564],{"class":402},"\"production\"",[141,1566,1556],{"class":165},[141,1568,1569],{"class":402},"\"dve\"",[141,1571,1550],{"class":165},[141,1573,1574],{"class":402},"\"dev\"",[141,1576,1556],{"class":165},[141,1578,1579],{"class":402},"\"xyz\"",[141,1581,1582],{"class":165},", []),\n",[141,1584,1585],{"class":143,"line":359},[141,1586,1587],{"class":165},"])\n",[141,1589,1590,1592,1595],{"class":143,"line":383},[141,1591,198],{"class":154},[141,1593,1594],{"class":201}," test_suggest",[141,1596,1597],{"class":165},"(typed, expected):\n",[141,1599,1600,1603,1606,1608,1610,1612,1614,1616,1619,1622],{"class":143,"line":394},[141,1601,1602],{"class":154},"    assert",[141,1604,1605],{"class":165}," suggest(typed, [",[141,1607,1574],{"class":402},[141,1609,21],{"class":165},[141,1611,1553],{"class":402},[141,1613,21],{"class":165},[141,1615,1564],{"class":402},[141,1617,1618],{"class":165},"]) ",[141,1620,1621],{"class":154},"==",[141,1623,1624],{"class":165}," expected\n",[141,1626,1627],{"class":143,"line":612},[141,1628,173],{"emptyLinePlaceholder":172},[141,1630,1631],{"class":143,"line":632},[141,1632,173],{"emptyLinePlaceholder":172},[141,1634,1635,1637,1640],{"class":143,"line":638},[141,1636,198],{"class":154},[141,1638,1639],{"class":201}," test_unknown_service_suggests",[141,1641,1642],{"class":165},"():\n",[141,1644,1645,1648,1650,1653,1656,1658,1661],{"class":143,"line":658},[141,1646,1647],{"class":165},"    result ",[141,1649,259],{"class":154},[141,1651,1652],{"class":165}," CliRunner().invoke(cli, [",[141,1654,1655],{"class":402},"\"restart\"",[141,1657,21],{"class":165},[141,1659,1660],{"class":402},"\"api-gatway\"",[141,1662,1587],{"class":165},[141,1664,1665,1667,1670,1672],{"class":143,"line":697},[141,1666,1602],{"class":154},[141,1668,1669],{"class":165}," result.exit_code ",[141,1671,1621],{"class":154},[141,1673,1674],{"class":158}," 1\n",[141,1676,1678,1680,1683,1685],{"class":143,"line":1677},21,[141,1679,1602],{"class":154},[141,1681,1682],{"class":402}," \"Did you mean 'api-gateway'?\"",[141,1684,650],{"class":154},[141,1686,1687],{"class":165}," result.output\n",[141,1689,1691],{"class":143,"line":1690},22,[141,1692,173],{"emptyLinePlaceholder":172},[141,1694,1696],{"class":143,"line":1695},23,[141,1697,173],{"emptyLinePlaceholder":172},[141,1699,1701,1703,1706],{"class":143,"line":1700},24,[141,1702,198],{"class":154},[141,1704,1705],{"class":201}," test_choice_suggests",[141,1707,1642],{"class":165},[141,1709,1711,1714],{"class":143,"line":1710},25,[141,1712,1713],{"class":201},"    @click.command",[141,1715,561],{"class":165},[141,1717,1719,1722,1724,1727,1729,1732,1734,1737,1739,1741,1743,1745,1747],{"class":143,"line":1718},26,[141,1720,1721],{"class":201},"    @click.option",[141,1723,331],{"class":165},[141,1725,1726],{"class":402},"\"--env\"",[141,1728,21],{"class":165},[141,1730,1731],{"class":305},"type",[141,1733,259],{"class":154},[141,1735,1736],{"class":165},"SuggestingChoice([",[141,1738,1574],{"class":402},[141,1740,21],{"class":165},[141,1742,1553],{"class":402},[141,1744,21],{"class":165},[141,1746,1564],{"class":402},[141,1748,1749],{"class":165},"]))\n",[141,1751,1753,1755,1758],{"class":143,"line":1752},27,[141,1754,807],{"class":154},[141,1756,1757],{"class":201}," deploy",[141,1759,1760],{"class":165},"(env):\n",[141,1762,1764],{"class":143,"line":1763},28,[141,1765,1766],{"class":165},"        click.echo(env)\n",[141,1768,1770],{"class":143,"line":1769},29,[141,1771,173],{"emptyLinePlaceholder":172},[141,1773,1775,1777,1779,1782,1784,1786,1788],{"class":143,"line":1774},30,[141,1776,1647],{"class":165},[141,1778,259],{"class":154},[141,1780,1781],{"class":165}," CliRunner().invoke(deploy, [",[141,1783,1726],{"class":402},[141,1785,21],{"class":165},[141,1787,1547],{"class":402},[141,1789,1587],{"class":165},[141,1791,1793,1795,1797,1799,1802,1804,1807,1809],{"class":143,"line":1792},31,[141,1794,1602],{"class":154},[141,1796,1669],{"class":165},[141,1798,1621],{"class":154},[141,1800,1801],{"class":158}," 2",[141,1803,1221],{"class":154},[141,1805,1806],{"class":402}," \"Did you mean 'staging'?\"",[141,1808,650],{"class":154},[141,1810,1687],{"class":165},[10,1812,1813],{},"Collect real typos from support requests and add them to the table — they are the best test data you will get.",[56,1815,1817],{"id":1816},"conclusion","Conclusion",[10,1819,1820,1821,1823,1824,1826],{},"Most CLIs already suggest corrections for mistyped commands and options; the remaining gaps are values and names. A ten-line helper combining prefix matches with ",[14,1822,451],{}," fills them: append its suggestions to \"unknown resource\" errors and to a ",[14,1825,742],{}," subclass, keep renamed commands working through aliases with a stderr warning, never auto-correct destructive actions, and test with the typos your users actually make.",[56,1828,1830],{"id":1829},"frequently-asked-questions","Frequently asked questions",[471,1832,1834,1835,1837],{"id":1833},"is-difflib-good-enough-or-do-i-need-a-fuzzy-matching-library","Is ",[14,1836,47],{}," good enough, or do I need a fuzzy-matching library?",[10,1839,1840,1841,1843],{},"For candidate lists of tens or hundreds of names, ",[14,1842,47],{}," is fast and good enough. Libraries such as rapidfuzz are faster and offer more scoring options, which matters for tens of thousands of candidates or real-time completion.",[471,1845,1847],{"id":1846},"should-suggestions-be-case-insensitive","Should suggestions be case-insensitive?",[10,1849,1850,1851,17,1854,1857],{},"If your names are case-insensitive, compare lower-cased forms and suggest the canonical spelling. If case matters, suggesting ",[14,1852,1853],{},"Billing",[14,1855,1856],{},"billing"," is itself a helpful hint.",[471,1859,1861],{"id":1860},"how-does-this-relate-to-shell-completion","How does this relate to shell completion?",[10,1863,1864,1865,54],{},"They complement each other: completion prevents typos for users who press Tab; suggestions rescue everyone else, including scripts copied from old documentation. Completion is covered in ",[50,1866,1868],{"href":1867},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002F","shell completion for Python CLIs",[471,1870,1872],{"id":1871},"can-typer-apps-use-the-same-suggestions","Can Typer apps use the same suggestions?",[10,1874,1875,1876,1879,1880,1883,1884,1887,1888,1891,1892,54],{},"Yes — raise ",[14,1877,1878],{},"typer.BadParameter"," or ",[14,1881,1882],{},"typer.Exit"," with a message built by ",[14,1885,1886],{},"did_you_mean",", or validate values in a ",[14,1889,1890],{},"parser="," function as in ",[50,1893,1895],{"href":1894},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dates-and-durations-in-cli-arguments\u002F","validating dates and durations in CLI arguments",[471,1897,1899],{"id":1898},"what-cutoff-should-i-use","What cutoff should I use?",[10,1901,1902,1903,1905],{},"Start with ",[14,1904,47],{},"'s default of 0.6 and adjust with real data. Short names need care: two three-letter names differing by one letter score 0.67 and will be suggested for each other, which is usually what you want; very different short names score low and are correctly left out.",[56,1907,1909],{"id":1908},"related","Related",[61,1911,1912,1918,1923,1929,1935],{},[64,1913,1914,1915],{},"Up: ",[50,1916,1917],{"href":52},"Error handling and exit codes",[64,1919,1920],{},[50,1921,1922],{"href":72},"Friendly error messages and tracebacks",[64,1924,1925],{},[50,1926,1928],{"href":1927},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fwriting-crash-reports-users-can-send\u002F","Writing crash reports users can send",[64,1930,1931],{},[50,1932,1934],{"href":1933},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fchoices-and-enums-in-typer-and-click\u002F","Choices and enums in Typer and Click",[64,1936,1937],{},[50,1938,1940],{"href":1939},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently\u002F","Naming commands and flags consistently",[1942,1943,1944],"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 .s4XuR, html code.shiki .s4XuR{--shiki-default:#E36209;--shiki-dark:#FFAB70}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}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":92,"searchDepth":151,"depth":151,"links":1946},[1947,1948,1949,1955,1956,1957,1958,1966],{"id":58,"depth":151,"text":59},{"id":76,"depth":151,"text":77},{"id":116,"depth":151,"text":117,"children":1950},[1951,1952,1953,1954],{"id":473,"depth":169,"text":474},{"id":735,"depth":169,"text":736},{"id":950,"depth":169,"text":951},{"id":1101,"depth":169,"text":1102},{"id":1370,"depth":151,"text":1371},{"id":1440,"depth":151,"text":1441},{"id":1816,"depth":151,"text":1817},{"id":1829,"depth":151,"text":1830,"children":1959},[1960,1962,1963,1964,1965],{"id":1833,"depth":169,"text":1961},"Is difflib good enough, or do I need a fuzzy-matching library?",{"id":1846,"depth":169,"text":1847},{"id":1860,"depth":169,"text":1861},{"id":1871,"depth":169,"text":1872},{"id":1898,"depth":169,"text":1899},{"id":1908,"depth":151,"text":1909},"2026-10-02","Help users recover from typos: what Click, Typer and argparse already suggest, adding suggestions for choices and resource names with difflib and prefixes, and aliases for renamed commands.","beginner",false,"md",{},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fdid-you-mean-suggestions-for-mistyped-input",{"title":5,"description":1968},"advanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fdid-you-mean-suggestions-for-mistyped-input\u002Findex",[1977,1978,794,47,1979],"errors","ux","suggestions","7qp3kGkv7x_b6SrvPqh2S6Nlqy7TZht3JLtZ-xsvu-E",[1982,1985,1988,1991,1994,1997,2000,2003,2006,2009,2012,2015,2018,2021,2024,2027,2030,2033,2036,2039,2042,2045,2048,2051,2054,2057,2060,2063,2066,2069,2072,2075,2076,2079,2082,2085,2088,2091,2094,2097,2100,2103,2106,2109,2112,2115,2118,2121,2124,2127,2130,2133,2136,2139,2142,2145,2148,2151,2154,2157,2160,2163,2166,2169,2172,2175,2178,2181,2184,2187,2190,2193,2196,2199,2202,2205,2208,2211,2214,2217,2220,2223,2226,2229,2232,2235,2238,2241,2244,2247,2250,2253,2256,2259,2262,2265,2268,2271,2274,2277,2280,2283,2286,2289,2292,2295,2298,2301,2304,2307,2310,2313,2316,2319,2322,2325,2328,2331,2334,2337,2340,2343,2346,2349,2352,2355,2358,2361,2364,2367,2370,2373,2376,2379,2382,2385,2388,2391,2394,2397,2400,2403,2406,2409,2412,2415,2418,2421,2424,2427,2430,2433,2436,2439,2442,2445,2448,2451,2454,2457,2460,2463,2466,2469,2472,2475,2478,2481,2484,2487,2490,2493,2496,2499,2502,2505,2508,2511,2514,2517,2520,2523,2526,2529,2532,2535,2538,2541,2544,2547,2550,2553,2556,2559,2562,2565,2568,2571,2574,2577,2580,2583,2586,2589,2592,2595,2598,2601,2604,2607,2610,2613,2616,2619,2622,2625,2628,2631,2634,2637,2640,2643,2646,2649,2652,2655,2658,2661,2664,2667,2670,2673,2676,2679,2682,2685,2688,2691,2694,2697,2700,2703,2706,2709,2712,2715,2718,2721,2724,2727,2730,2733,2736,2739,2742,2745,2748,2751,2754,2757,2760,2763,2766,2769,2772,2775,2778,2781,2784,2787,2790,2793,2796,2799,2802,2805,2808,2811,2814,2817,2820,2823],{"path":1983,"title":1984},"\u002Fabout","About Python CLI Toolcraft",{"path":1986,"title":1987},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":1989,"title":1990},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":1992,"title":1993},"\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":1995,"title":1996},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":1998,"title":1999},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":2001,"title":2002},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-urls-hosts-and-ports","Validating URLs, Hosts and Ports in Python CLI Arguments",{"path":2004,"title":2005},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":2007,"title":2008},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbrowsing-records-with-a-textual-datatable","Browsing Records with a Textual DataTable Picker",{"path":2010,"title":2011},"\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":2013,"title":2014},"\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":2016,"title":2017},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":2019,"title":2020},"\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":2022,"title":2023},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fstyling-textual-apps-with-tcss","Styling Textual Apps with TCSS",{"path":2025,"title":2026},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":2028,"title":2029},"\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":2031,"title":2032},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fdocumenting-environment-variables-in-help","Documenting Environment Variables in CLI Help",{"path":2034,"title":2035},"\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":2037,"title":2038},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":2040,"title":2041},"\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":2043,"title":2044},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":2046,"title":2047},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":2049,"title":2050},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":2052,"title":2053},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":2055,"title":2056},"\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":2058,"title":2059},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fhandling-ansi-escape-codes-on-windows-consoles","Handling ANSI Escape Codes on Windows Consoles",{"path":2061,"title":2062},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":2064,"title":2065},"\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":2067,"title":2068},"\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":2070,"title":2071},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":2073,"title":2074},"\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":1973,"title":5},{"path":2077,"title":2078},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":2080,"title":2081},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":2083,"title":2084},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":2086,"title":2087},"\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":2089,"title":2090},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fwriting-crash-reports-users-can-send","Writing Crash Reports Users Can Send",{"path":2092,"title":2093},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":2095,"title":2096},"\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":2098,"title":2099},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":2101,"title":2102},"\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":2104,"title":2105},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":2107,"title":2108},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":2110,"title":2111},"\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":2113,"title":2114},"\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":2116,"title":2117},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":2119,"title":2120},"\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":2122,"title":2123},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":2125,"title":2126},"\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":2128,"title":2129},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":2131,"title":2132},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":2134,"title":2135},"\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":2137,"title":2138},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":2140,"title":2141},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":2143,"title":2144},"\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":2146,"title":2147},"\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":2149,"title":2150},"\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":2152,"title":2153},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis","Output Formats for Data-Heavy Python CLIs",{"path":2155,"title":2156},"\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":2158,"title":2159},"\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":2161,"title":2162},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fargcomplete-for-argparse-clis","Tab Completion for argparse CLIs with argcomplete",{"path":2164,"title":2165},"\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":2167,"title":2168},"\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":2170,"title":2171},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":2173,"title":2174},"\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":2176,"title":2177},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages","Shipping Shell Completion Scripts with a Python CLI",{"path":2179,"title":2180},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":2182,"title":2183},"\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":2185,"title":2186},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":2188,"title":2189},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":2191,"title":2192},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Flogging-with-structlog-in-a-cli","Logging with structlog in a Python CLI",{"path":2194,"title":2195},"\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":2197,"title":2198},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":2200,"title":2201},"\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":2203,"title":2204},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":2206,"title":2207},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":2209,"title":2210},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":2212,"title":2213},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":2215,"title":2216},"\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":2218,"title":2219},"\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":2221,"title":2222},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":2224,"title":2225},"\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":2227,"title":2228},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":2230,"title":2231},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":2233,"title":2234},"\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":2236,"title":2237},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":2239,"title":2240},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":2242,"title":2243},"\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":2245,"title":2246},"\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":2248,"title":2249},"\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":2251,"title":2252},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":2254,"title":2255},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":2257,"title":2258},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":2260,"title":2261},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":2263,"title":2264},"\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":2266,"title":2267},"\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":2269,"title":2270},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fstructured-concurrency-with-taskgroups-in-clis","Structured Concurrency with TaskGroups in Python CLIs",{"path":2272,"title":2273},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":2275,"title":2276},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":2278,"title":2279},"\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":2281,"title":2282},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":2284,"title":2285},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":2287,"title":2288},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":2290,"title":2291},"\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":2293,"title":2294},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":2296,"title":2297},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":2299,"title":2300},"\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":2302,"title":2303},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis","Local State and SQLite in Python CLIs",{"path":2305,"title":2306},"\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":2308,"title":2309},"\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":2311,"title":2312},"\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":2314,"title":2315},"\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":2317,"title":2318},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":2320,"title":2321},"\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":2323,"title":2324},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":2326,"title":2327},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Freloading-config-on-sighup","Reloading Configuration on SIGHUP in a Python CLI",{"path":2329,"title":2330},"\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":2332,"title":2333},"\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":2335,"title":2336},"\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":2338,"title":2339},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":2341,"title":2342},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":2344,"title":2345},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":2347,"title":2348},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":2350,"title":2351},"\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":2353,"title":2354},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fpiping-between-subprocesses-in-python","Piping Between Subprocesses in Python Without a Shell",{"path":2356,"title":2357},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":2359,"title":2360},"\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":2362,"title":2363},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":2365,"title":2366},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":2368,"title":2369},"\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":2371,"title":2372},"\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":2374,"title":2375},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Frefreshing-expired-tokens-automatically","Refreshing Expired Tokens Automatically in a Python CLI",{"path":2377,"title":2378},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":2380,"title":2381},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":2383,"title":2384},"\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":2386,"title":2387},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis","Update Checks, Upgrade Commands and Telemetry for Python CLIs",{"path":2389,"title":2390},"\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":2392,"title":2393},"\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":2395,"title":2396},"\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":2398,"title":2399},"\u002F","Python CLI Toolcraft",{"path":2401,"title":2402},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo","Building a Python CLI with Cleo Command Classes",{"path":2404,"title":2405},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts","Building a Type-Hinted Python CLI with Cyclopts",{"path":2407,"title":2408},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks","Beyond Click and Typer: Alternative Python CLI Frameworks",{"path":2410,"title":2411},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fquick-clis-from-functions-with-python-fire","Quick CLIs from Functions with Python Fire",{"path":2413,"title":2414},"\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":2416,"title":2417},"\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":2419,"title":2420},"\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":2422,"title":2423},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fguarding-startup-with-import-tests","Guarding CLI Startup with Import Tests",{"path":2425,"title":2426},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":2428,"title":2429},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":2431,"title":2432},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":2434,"title":2435},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":2437,"title":2438},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":2440,"title":2441},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":2443,"title":2444},"\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":2446,"title":2447},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":2449,"title":2450},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":2452,"title":2453},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":2455,"title":2456},"\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":2458,"title":2459},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":2461,"title":2462},"\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":2464,"title":2465},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fdesigning-idempotent-commands","Designing Idempotent Commands in a Python CLI",{"path":2467,"title":2468},"\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":2470,"title":2471},"\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":2473,"title":2474},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":2476,"title":2477},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":2479,"title":2480},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fpositional-arguments-vs-options","Positional Arguments vs Options: Designing a CLI Signature",{"path":2482,"title":2483},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":2485,"title":2486},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":2488,"title":2489},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":2491,"title":2492},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":2494,"title":2495},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures","Isolating Plugin Failures in an Extensible Python CLI",{"path":2497,"title":2498},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli","Testing Plugins Against the Host CLI",{"path":2500,"title":2501},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":2503,"title":2504},"\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":2506,"title":2507},"\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":2509,"title":2510},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":2512,"title":2513},"\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":2515,"title":2516},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":2518,"title":2519},"\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":2521,"title":2522},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically","Registering CLI Commands from Modules Automatically",{"path":2524,"title":2525},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":2527,"title":2528},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":2530,"title":2531},"\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":2533,"title":2534},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":2536,"title":2537},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":2539,"title":2540},"\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":2542,"title":2543},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":2545,"title":2546},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":2548,"title":2549},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":2551,"title":2552},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-commands-that-call-subprocesses","Testing Python CLI Commands That Call Subprocesses",{"path":2554,"title":2555},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":2557,"title":2558},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands","Transcript Tests for Python CLI Commands",{"path":2560,"title":2561},"\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":2563,"title":2564},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":2566,"title":2567},"\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":2569,"title":2570},"\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":2572,"title":2573},"\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":2575,"title":2576},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":2578,"title":2579},"\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":2581,"title":2582},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":2584,"title":2585},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":2587,"title":2588},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":2590,"title":2591},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":2593,"title":2594},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":2596,"title":2597},"\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":2599,"title":2600},"\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":2602,"title":2603},"\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":2605,"title":2606},"\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":2608,"title":2609},"\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":2611,"title":2612},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":2614,"title":2615},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":2617,"title":2618},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":2620,"title":2621},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":2623,"title":2624},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftemplate-variables-and-conditional-files","Template Variables and Conditional Files in CLI Templates",{"path":2626,"title":2627},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftesting-a-project-template-with-pytest","Testing a CLI Project Template with pytest",{"path":2629,"title":2630},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fupdating-generated-projects-with-copier-update","Updating Generated CLI Projects with copier update",{"path":2632,"title":2633},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":2635,"title":2636},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":2638,"title":2639},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fcode-signing-and-notarizing-cli-binaries","Code Signing and Notarizing Python CLI Binaries",{"path":2641,"title":2642},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":2644,"title":2645},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":2647,"title":2648},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":2650,"title":2651},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Freducing-pyinstaller-binary-size","Reducing the Size of a PyInstaller CLI Binary",{"path":2653,"title":2654},"\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":2656,"title":2657},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":2659,"title":2660},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":2662,"title":2663},"\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":2665,"title":2666},"\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":2668,"title":2669},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":2671,"title":2672},"\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":2674,"title":2675},"\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":2677,"title":2678},"\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":2680,"title":2681},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":2683,"title":2684},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fbumping-versions-consistently-across-a-cli-project","Bumping Versions Consistently Across a Python CLI Project",{"path":2686,"title":2687},"\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":2689,"title":2690},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":2692,"title":2693},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":2695,"title":2696},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":2698,"title":2699},"\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":2701,"title":2702},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":2704,"title":2705},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":2707,"title":2708},"\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":2710,"title":2711},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":2713,"title":2714},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":2716,"title":2717},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Foptional-dependencies-and-extras-for-clis","Optional Dependencies and Extras for Python CLIs",{"path":2719,"title":2720},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":2722,"title":2723},"\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":2725,"title":2726},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fdynamic-versioning-with-poetry-plugins","Dynamic Versioning for a Poetry CLI from Git Tags",{"path":2728,"title":2729},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":2731,"title":2732},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmanaging-poetry-lock-files-for-cli-tools","Managing Poetry Lock Files for CLI Tools",{"path":2734,"title":2735},"\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":2737,"title":2738},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":2740,"title":2741},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":2743,"title":2744},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpublishing-a-cli-with-poetry","Building and Publishing a Python CLI with Poetry",{"path":2746,"title":2747},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":2749,"title":2750},"\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":2752,"title":2753},"\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":2755,"title":2756},"\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":2758,"title":2759},"\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":2761,"title":2762},"\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":2764,"title":2765},"\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":2767,"title":2768},"\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":2770,"title":2771},"\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":2773,"title":2774},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain","Securing the Supply Chain of a Python CLI",{"path":2776,"title":2777},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpinning-dependencies-with-hashes","Pinning a Python CLI’s Dependencies with Hashes",{"path":2779,"title":2780},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpublishing-attestations-and-verifying-releases","Publishing Attestations and Verifying Python CLI Releases",{"path":2782,"title":2783},"\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":2785,"title":2786},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":2788,"title":2789},"\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":2791,"title":2792},"\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":2794,"title":2795},"\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":2797,"title":2798},"\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":2800,"title":2801},"\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":2803,"title":2804},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":2806,"title":2807},"\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":2809,"title":2810},"\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":2812,"title":2813},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":2815,"title":2816},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fisolating-cli-tools-from-project-dependencies","Isolating CLI Tools from Your Project’s Dependencies",{"path":2818,"title":2819},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":2821,"title":2822},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":2824,"title":2825},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1790967537204]