[{"data":1,"prerenderedAt":2469},["ShallowReactive",2],{"page-\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Frich-markup-and-help-panels-in-typer\u002F":3,"content-directory":1625},{"id":4,"title":5,"body":6,"date":1610,"description":1611,"difficulty":1612,"draft":1613,"extension":1614,"meta":1615,"navigation":105,"path":1616,"seo":1617,"stem":1618,"tags":1619,"updated":1610,"__hash__":1624},"content\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Frich-markup-and-help-panels-in-typer\u002Findex.md","Rich Markup and Help Panels in Typer",{"type":7,"value":8,"toc":1588},"minimark",[9,37,42,61,65,644,647,655,658,664,668,673,683,687,693,750,753,756,760,776,780,787,861,876,880,887,951,971,975,1001,1004,1008,1052,1056,1059,1468,1476,1480,1492,1496,1500,1511,1515,1522,1526,1536,1540,1543,1547,1550,1554,1584],[10,11,12,13,17,18,21,22,25,26,31,32,36],"p",{},"Typer renders help with Rich: boxed sections, aligned columns, colours on a capable terminal. Out of the box everything lands in two boxes — \"Options\" and \"Commands\" — which is fine for a handful of entries and hard to scan for twenty. Typer lets you split both into named ",[14,15,16],"strong",{},"help panels",", use ",[14,19,20],{},"Rich markup"," inside help strings to highlight what matters, add an ",[14,23,24],{},"epilog"," with links, and control how uncaught exceptions are displayed. A few lines of configuration turn a long, flat help screen into one users can navigate. This guide covers panels, markup modes, epilogs and pretty exceptions, notes what changes when output is not a terminal, and shows how to test the layout. It belongs to the ",[27,28,30],"a",{"href":29},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002F","Typer vs Click topic",", complementing the content advice in ",[27,33,35],{"href":34},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read\u002F","writing help text users actually read",".",[38,39,41],"h2",{"id":40},"prerequisites","Prerequisites",[43,44,45,49],"ul",{},[46,47,48],"li",{},"Typer 0.12+ (examples checked with 0.27), which includes Rich.",[46,50,51,52,56,57,36],{},"The ",[53,54,55],"code",{},"Annotated"," style from ",[27,58,60],{"href":59},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer\u002F","using Annotated options in Typer",[38,62,64],{"id":63},"the-recipe","The recipe",[66,67,72],"pre",{"className":68,"code":69,"language":70,"meta":71,"style":71},"language-python shiki shiki-themes github-light github-dark","# src\u002Fmytool\u002Fcli.py\nfrom typing import Annotated\n\nimport typer\n\napp = typer.Typer(\n    rich_markup_mode=\"rich\",\n    help=\"[bold]mytool[\u002Fbold] — deploy and inspect services.\",\n    epilog=\"Docs: [link=https:\u002F\u002Fexample.com\u002Fmytool]example.com\u002Fmytool[\u002Flink]\",\n)\n\n\n@app.callback()\ndef main() -> None:\n    pass\n\n\n@app.command(rich_help_panel=\"Deploying\")\ndef deploy(\n    service: Annotated[str, typer.Argument(help=\"Service to deploy, e.g. [cyan]api[\u002Fcyan].\")],\n    env: Annotated[str, typer.Option(help=\"Target environment.\", rich_help_panel=\"Target\")] = \"staging\",\n    region: Annotated[str, typer.Option(help=\"Region code.\", rich_help_panel=\"Target\")] = \"eu-west-1\",\n    dry_run: Annotated[bool, typer.Option(\n        \"--dry-run\", help=\"Show the plan [yellow]without[\u002Fyellow] changing anything.\",\n        rich_help_panel=\"Safety\")] = False,\n    yes: Annotated[bool, typer.Option(\n        \"--yes\", \"-y\", help=\"Skip the confirmation prompt.\", rich_help_panel=\"Safety\")] = False,\n) -> None:\n    \"\"\"Deploy [bold]SERVICE[\u002Fbold] to an environment.\n\n    Rolls out the current build. Use [green]--dry-run[\u002Fgreen] first.\n    \"\"\"\n    typer.echo(\"ok\")\n\n\n@app.command(rich_help_panel=\"Deploying\")\ndef rollback(service: str) -> None:\n    \"\"\"Roll back to the previous release.\"\"\"\n\n\n@app.command(rich_help_panel=\"Inspecting\")\ndef status() -> None:\n    \"\"\"Show service status.\"\"\"\n\n\n@app.command(rich_help_panel=\"Inspecting\")\ndef logs(service: str) -> None:\n    \"\"\"Tail service logs.\"\"\"\n","python","",[53,73,74,83,100,107,115,120,132,148,161,174,180,185,190,200,219,225,230,235,254,265,288,326,360,372,389,409,419,455,465,471,476,482,488,499,504,509,524,543,549,554,559,575,589,595,600,605,620,638],{"__ignoreMap":71},[75,76,79],"span",{"class":77,"line":78},"line",1,[75,80,82],{"class":81},"sJ8bj","# src\u002Fmytool\u002Fcli.py\n",[75,84,86,90,94,97],{"class":77,"line":85},2,[75,87,89],{"class":88},"szBVR","from",[75,91,93],{"class":92},"sVt8B"," typing ",[75,95,96],{"class":88},"import",[75,98,99],{"class":92}," Annotated\n",[75,101,103],{"class":77,"line":102},3,[75,104,106],{"emptyLinePlaceholder":105},true,"\n",[75,108,110,112],{"class":77,"line":109},4,[75,111,96],{"class":88},[75,113,114],{"class":92}," typer\n",[75,116,118],{"class":77,"line":117},5,[75,119,106],{"emptyLinePlaceholder":105},[75,121,123,126,129],{"class":77,"line":122},6,[75,124,125],{"class":92},"app ",[75,127,128],{"class":88},"=",[75,130,131],{"class":92}," typer.Typer(\n",[75,133,135,139,141,145],{"class":77,"line":134},7,[75,136,138],{"class":137},"s4XuR","    rich_markup_mode",[75,140,128],{"class":88},[75,142,144],{"class":143},"sZZnC","\"rich\"",[75,146,147],{"class":92},",\n",[75,149,151,154,156,159],{"class":77,"line":150},8,[75,152,153],{"class":137},"    help",[75,155,128],{"class":88},[75,157,158],{"class":143},"\"[bold]mytool[\u002Fbold] — deploy and inspect services.\"",[75,160,147],{"class":92},[75,162,164,167,169,172],{"class":77,"line":163},9,[75,165,166],{"class":137},"    epilog",[75,168,128],{"class":88},[75,170,171],{"class":143},"\"Docs: [link=https:\u002F\u002Fexample.com\u002Fmytool]example.com\u002Fmytool[\u002Flink]\"",[75,173,147],{"class":92},[75,175,177],{"class":77,"line":176},10,[75,178,179],{"class":92},")\n",[75,181,183],{"class":77,"line":182},11,[75,184,106],{"emptyLinePlaceholder":105},[75,186,188],{"class":77,"line":187},12,[75,189,106],{"emptyLinePlaceholder":105},[75,191,193,197],{"class":77,"line":192},13,[75,194,196],{"class":195},"sScJk","@app.callback",[75,198,199],{"class":92},"()\n",[75,201,203,206,209,212,216],{"class":77,"line":202},14,[75,204,205],{"class":88},"def",[75,207,208],{"class":195}," main",[75,210,211],{"class":92},"() -> ",[75,213,215],{"class":214},"sj4cs","None",[75,217,218],{"class":92},":\n",[75,220,222],{"class":77,"line":221},15,[75,223,224],{"class":88},"    pass\n",[75,226,228],{"class":77,"line":227},16,[75,229,106],{"emptyLinePlaceholder":105},[75,231,233],{"class":77,"line":232},17,[75,234,106],{"emptyLinePlaceholder":105},[75,236,238,241,244,247,249,252],{"class":77,"line":237},18,[75,239,240],{"class":195},"@app.command",[75,242,243],{"class":92},"(",[75,245,246],{"class":137},"rich_help_panel",[75,248,128],{"class":88},[75,250,251],{"class":143},"\"Deploying\"",[75,253,179],{"class":92},[75,255,257,259,262],{"class":77,"line":256},19,[75,258,205],{"class":88},[75,260,261],{"class":195}," deploy",[75,263,264],{"class":92},"(\n",[75,266,268,271,274,277,280,282,285],{"class":77,"line":267},20,[75,269,270],{"class":92},"    service: Annotated[",[75,272,273],{"class":214},"str",[75,275,276],{"class":92},", typer.Argument(",[75,278,279],{"class":137},"help",[75,281,128],{"class":88},[75,283,284],{"class":143},"\"Service to deploy, e.g. [cyan]api[\u002Fcyan].\"",[75,286,287],{"class":92},")],\n",[75,289,291,294,296,299,301,303,306,309,311,313,316,319,321,324],{"class":77,"line":290},21,[75,292,293],{"class":92},"    env: Annotated[",[75,295,273],{"class":214},[75,297,298],{"class":92},", typer.Option(",[75,300,279],{"class":137},[75,302,128],{"class":88},[75,304,305],{"class":143},"\"Target environment.\"",[75,307,308],{"class":92},", ",[75,310,246],{"class":137},[75,312,128],{"class":88},[75,314,315],{"class":143},"\"Target\"",[75,317,318],{"class":92},")] ",[75,320,128],{"class":88},[75,322,323],{"class":143}," \"staging\"",[75,325,147],{"class":92},[75,327,329,332,334,336,338,340,343,345,347,349,351,353,355,358],{"class":77,"line":328},22,[75,330,331],{"class":92},"    region: Annotated[",[75,333,273],{"class":214},[75,335,298],{"class":92},[75,337,279],{"class":137},[75,339,128],{"class":88},[75,341,342],{"class":143},"\"Region code.\"",[75,344,308],{"class":92},[75,346,246],{"class":137},[75,348,128],{"class":88},[75,350,315],{"class":143},[75,352,318],{"class":92},[75,354,128],{"class":88},[75,356,357],{"class":143}," \"eu-west-1\"",[75,359,147],{"class":92},[75,361,363,366,369],{"class":77,"line":362},23,[75,364,365],{"class":92},"    dry_run: Annotated[",[75,367,368],{"class":214},"bool",[75,370,371],{"class":92},", typer.Option(\n",[75,373,375,378,380,382,384,387],{"class":77,"line":374},24,[75,376,377],{"class":143},"        \"--dry-run\"",[75,379,308],{"class":92},[75,381,279],{"class":137},[75,383,128],{"class":88},[75,385,386],{"class":143},"\"Show the plan [yellow]without[\u002Fyellow] changing anything.\"",[75,388,147],{"class":92},[75,390,392,395,397,400,402,404,407],{"class":77,"line":391},25,[75,393,394],{"class":137},"        rich_help_panel",[75,396,128],{"class":88},[75,398,399],{"class":143},"\"Safety\"",[75,401,318],{"class":92},[75,403,128],{"class":88},[75,405,406],{"class":214}," False",[75,408,147],{"class":92},[75,410,412,415,417],{"class":77,"line":411},26,[75,413,414],{"class":92},"    yes: Annotated[",[75,416,368],{"class":214},[75,418,371],{"class":92},[75,420,422,425,427,430,432,434,436,439,441,443,445,447,449,451,453],{"class":77,"line":421},27,[75,423,424],{"class":143},"        \"--yes\"",[75,426,308],{"class":92},[75,428,429],{"class":143},"\"-y\"",[75,431,308],{"class":92},[75,433,279],{"class":137},[75,435,128],{"class":88},[75,437,438],{"class":143},"\"Skip the confirmation prompt.\"",[75,440,308],{"class":92},[75,442,246],{"class":137},[75,444,128],{"class":88},[75,446,399],{"class":143},[75,448,318],{"class":92},[75,450,128],{"class":88},[75,452,406],{"class":214},[75,454,147],{"class":92},[75,456,458,461,463],{"class":77,"line":457},28,[75,459,460],{"class":92},") -> ",[75,462,215],{"class":214},[75,464,218],{"class":92},[75,466,468],{"class":77,"line":467},29,[75,469,470],{"class":143},"    \"\"\"Deploy [bold]SERVICE[\u002Fbold] to an environment.\n",[75,472,474],{"class":77,"line":473},30,[75,475,106],{"emptyLinePlaceholder":105},[75,477,479],{"class":77,"line":478},31,[75,480,481],{"class":143},"    Rolls out the current build. Use [green]--dry-run[\u002Fgreen] first.\n",[75,483,485],{"class":77,"line":484},32,[75,486,487],{"class":143},"    \"\"\"\n",[75,489,491,494,497],{"class":77,"line":490},33,[75,492,493],{"class":92},"    typer.echo(",[75,495,496],{"class":143},"\"ok\"",[75,498,179],{"class":92},[75,500,502],{"class":77,"line":501},34,[75,503,106],{"emptyLinePlaceholder":105},[75,505,507],{"class":77,"line":506},35,[75,508,106],{"emptyLinePlaceholder":105},[75,510,512,514,516,518,520,522],{"class":77,"line":511},36,[75,513,240],{"class":195},[75,515,243],{"class":92},[75,517,246],{"class":137},[75,519,128],{"class":88},[75,521,251],{"class":143},[75,523,179],{"class":92},[75,525,527,529,532,535,537,539,541],{"class":77,"line":526},37,[75,528,205],{"class":88},[75,530,531],{"class":195}," rollback",[75,533,534],{"class":92},"(service: ",[75,536,273],{"class":214},[75,538,460],{"class":92},[75,540,215],{"class":214},[75,542,218],{"class":92},[75,544,546],{"class":77,"line":545},38,[75,547,548],{"class":143},"    \"\"\"Roll back to the previous release.\"\"\"\n",[75,550,552],{"class":77,"line":551},39,[75,553,106],{"emptyLinePlaceholder":105},[75,555,557],{"class":77,"line":556},40,[75,558,106],{"emptyLinePlaceholder":105},[75,560,562,564,566,568,570,573],{"class":77,"line":561},41,[75,563,240],{"class":195},[75,565,243],{"class":92},[75,567,246],{"class":137},[75,569,128],{"class":88},[75,571,572],{"class":143},"\"Inspecting\"",[75,574,179],{"class":92},[75,576,578,580,583,585,587],{"class":77,"line":577},42,[75,579,205],{"class":88},[75,581,582],{"class":195}," status",[75,584,211],{"class":92},[75,586,215],{"class":214},[75,588,218],{"class":92},[75,590,592],{"class":77,"line":591},43,[75,593,594],{"class":143},"    \"\"\"Show service status.\"\"\"\n",[75,596,598],{"class":77,"line":597},44,[75,599,106],{"emptyLinePlaceholder":105},[75,601,603],{"class":77,"line":602},45,[75,604,106],{"emptyLinePlaceholder":105},[75,606,608,610,612,614,616,618],{"class":77,"line":607},46,[75,609,240],{"class":195},[75,611,243],{"class":92},[75,613,246],{"class":137},[75,615,128],{"class":88},[75,617,572],{"class":143},[75,619,179],{"class":92},[75,621,623,625,628,630,632,634,636],{"class":77,"line":622},47,[75,624,205],{"class":88},[75,626,627],{"class":195}," logs",[75,629,534],{"class":92},[75,631,273],{"class":214},[75,633,460],{"class":92},[75,635,215],{"class":214},[75,637,218],{"class":92},[75,639,641],{"class":77,"line":640},48,[75,642,643],{"class":143},"    \"\"\"Tail service logs.\"\"\"\n",[10,645,646],{},"The top-level help now groups commands by what users want to do:",[66,648,653],{"className":649,"code":651,"language":652,"meta":71},[650],"language-text","╭─ Deploying ──────────────────────────────────────────────────────────╮\n│ deploy    Deploy SERVICE to an environment.                          │\n│ rollback  Roll back to the previous release.                         │\n╰──────────────────────────────────────────────────────────────────────╯\n╭─ Inspecting ─────────────────────────────────────────────────────────╮\n│ status    Show service status.                                       │\n│ logs      Tail service logs.                                         │\n╰──────────────────────────────────────────────────────────────────────╯\n Docs: example.com\u002Fmytool\n","text",[53,654,651],{"__ignoreMap":71},[10,656,657],{},"And the command's own help separates targeting options from safety switches:",[66,659,662],{"className":660,"code":661,"language":652,"meta":71},[650],"╭─ Target ─────────────────────────────────────────────────────────────╮\n│ --env           \u003Cstr>  Target environment. [default: staging]        │\n│ --region        \u003Cstr>  Region code. [default: eu-west-1]             │\n╰──────────────────────────────────────────────────────────────────────╯\n╭─ Safety ─────────────────────────────────────────────────────────────╮\n│ --dry-run            Show the plan without changing anything.        │\n│ --yes      -y        Skip the confirmation prompt.                   │\n╰──────────────────────────────────────────────────────────────────────╯\n",[53,663,661],{"__ignoreMap":71},[665,666],"inline-diagram",{"name":667},"panels-before-after",[669,670,672],"h3",{"id":671},"help-panels","Help panels",[10,674,675,678,679,682],{},[53,676,677],{},"rich_help_panel="," on a command or option names the box it appears in. Panels appear in the order they are first used, after the default \"Options\" or \"Commands\" box, so declare the most important group first. Parameters and commands without a panel stay in the default box, which is a good home for ",[53,680,681],{},"--help"," and the completion options. Panels are presentation only: parsing, defaults and validation are unchanged.",[669,684,686],{"id":685},"markup-modes","Markup modes",[10,688,689,692],{},[53,690,691],{},"rich_markup_mode"," decides how help text is interpreted:",[43,694,695,728,743],{},[46,696,697,701,702,308,705,308,708,711,712,716,717,720,721,724,725,36],{},[14,698,699],{},[53,700,144],{}," (the default in current Typer) — Rich console markup: ",[53,703,704],{},"[bold]",[53,706,707],{},"[green]",[53,709,710],{},"[link=…]…[\u002Flink]",", and so on. Square brackets that are ",[713,714,715],"em",{},"not"," markup need escaping as ",[53,718,719],{},"\\[",", which matters for help that mentions ",[53,722,723],{},"[default]"," or shows an option like ",[53,726,727],{},"--format [json|csv]",[46,729,730,735,736,308,739,742],{},[14,731,732],{},[53,733,734],{},"\"markdown\""," — help strings and docstrings are rendered as Markdown: ",[53,737,738],{},"**bold**",[53,740,741],{},"`code`",", bullet lists, links. Natural if your docs are Markdown anyway.",[46,744,745,749],{},[14,746,747],{},[53,748,215],{}," — plain text, no markup interpretation, the safest choice when help text is generated from data you do not control.",[10,751,752],{},"Pick one mode for the whole application, and keep markup light: a highlighted flag or a warning colour helps; a rainbow does not.",[665,754],{"name":755},"panels-markup-modes",[669,757,759],{"id":758},"epilogs-and-docstrings","Epilogs and docstrings",[10,761,51,762,764,765,767,768,771,772,36],{},[53,763,24],{}," appears after all panels — the place for a docs link, a pointer to ",[53,766,681],{}," of subcommands, or a short example. In command docstrings, the first line becomes the one-line summary shown in the parent's command list, and the rest becomes the command's description, which is why ",[53,769,770],{},"deploy","'s second paragraph only appears in its own help. Longer examples are better in the epilog than the docstring, as discussed in ",[27,773,775],{"href":774},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fadding-examples-and-epilogs-to-help-output\u002F","adding examples and epilogs to help output",[669,777,779],{"id":778},"panels-for-sub-applications","Panels for sub-applications",[10,781,782,783,786],{},"Larger CLIs are assembled from several Typer apps with ",[53,784,785],{},"add_typer",", and the same parameter places a whole command group into a panel:",[66,788,790],{"className":68,"code":789,"language":70,"meta":71,"style":71},"app.add_typer(users_app, name=\"users\", rich_help_panel=\"Administration\")\napp.add_typer(audit_app, name=\"audit\", rich_help_panel=\"Administration\")\napp.add_typer(services_app, name=\"services\", rich_help_panel=\"Operations\")\n",[53,791,792,816,838],{"__ignoreMap":71},[75,793,794,797,800,802,805,807,809,811,814],{"class":77,"line":78},[75,795,796],{"class":92},"app.add_typer(users_app, ",[75,798,799],{"class":137},"name",[75,801,128],{"class":88},[75,803,804],{"class":143},"\"users\"",[75,806,308],{"class":92},[75,808,246],{"class":137},[75,810,128],{"class":88},[75,812,813],{"class":143},"\"Administration\"",[75,815,179],{"class":92},[75,817,818,821,823,825,828,830,832,834,836],{"class":77,"line":85},[75,819,820],{"class":92},"app.add_typer(audit_app, ",[75,822,799],{"class":137},[75,824,128],{"class":88},[75,826,827],{"class":143},"\"audit\"",[75,829,308],{"class":92},[75,831,246],{"class":137},[75,833,128],{"class":88},[75,835,813],{"class":143},[75,837,179],{"class":92},[75,839,840,843,845,847,850,852,854,856,859],{"class":77,"line":102},[75,841,842],{"class":92},"app.add_typer(services_app, ",[75,844,799],{"class":137},[75,846,128],{"class":88},[75,848,849],{"class":143},"\"services\"",[75,851,308],{"class":92},[75,853,246],{"class":137},[75,855,128],{"class":88},[75,857,858],{"class":143},"\"Operations\"",[75,860,179],{"class":92},[10,862,863,864,866,867,871,872,875],{},"That keeps the top-level help short — a handful of panels with a few groups each — while each group's own ",[53,865,681],{}," lists its commands in detail. It also works well with automatically registered command modules, as in ",[27,868,870],{"href":869},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically\u002F","registering commands from modules automatically",": a module can declare its panel next to its ",[53,873,874],{},"COMMAND_NAME",", and the registration loop passes it through.",[38,877,879],{"id":878},"pretty-exceptions","Pretty exceptions",[10,881,882,883,886],{},"Typer also installs a Rich-based exception handler, which prints uncaught exceptions as a formatted, shortened traceback. Three settings on ",[53,884,885],{},"typer.Typer"," control it:",[66,888,890],{"className":68,"code":889,"language":70,"meta":71,"style":71},"app = typer.Typer(\n    pretty_exceptions_enable=True,        # Rich tracebacks for uncaught errors\n    pretty_exceptions_short=True,         # hide frames from Typer and Click internals\n    pretty_exceptions_show_locals=False,  # never print local variables\n)\n",[53,891,892,900,916,931,947],{"__ignoreMap":71},[75,893,894,896,898],{"class":77,"line":78},[75,895,125],{"class":92},[75,897,128],{"class":88},[75,899,131],{"class":92},[75,901,902,905,907,910,913],{"class":77,"line":85},[75,903,904],{"class":137},"    pretty_exceptions_enable",[75,906,128],{"class":88},[75,908,909],{"class":214},"True",[75,911,912],{"class":92},",        ",[75,914,915],{"class":81},"# Rich tracebacks for uncaught errors\n",[75,917,918,921,923,925,928],{"class":77,"line":102},[75,919,920],{"class":137},"    pretty_exceptions_short",[75,922,128],{"class":88},[75,924,909],{"class":214},[75,926,927],{"class":92},",         ",[75,929,930],{"class":81},"# hide frames from Typer and Click internals\n",[75,932,933,936,938,941,944],{"class":77,"line":109},[75,934,935],{"class":137},"    pretty_exceptions_show_locals",[75,937,128],{"class":88},[75,939,940],{"class":214},"False",[75,942,943],{"class":92},",  ",[75,945,946],{"class":81},"# never print local variables\n",[75,948,949],{"class":77,"line":117},[75,950,179],{"class":92},[10,952,953,954,957,958,962,963,966,967,970],{},"Keep ",[53,955,956],{},"pretty_exceptions_show_locals=False",", which is the current default: local variables in a CLI frequently include tokens, passwords from prompts and file contents, and a traceback pasted into an issue tracker would publish them. Better still, catch expected errors and print a one-line message, reserving tracebacks for genuine bugs — the approach in ",[27,959,961],{"href":960},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks\u002F","friendly error messages and tracebacks",". Setting the environment variable ",[53,964,965],{},"TYPER_STANDARD_TRACEBACK=1"," switches back to plain Python tracebacks (older releases used ",[53,968,969],{},"_TYPER_STANDARD_TRACEBACK",", which is still honoured), which is handy when debugging or when a log collector parses tracebacks.",[38,972,974],{"id":973},"when-output-is-not-a-terminal","When output is not a terminal",[10,976,977,978,981,982,985,986,989,990,992,993,996,997,36],{},"Rich adapts to where output goes. Under ",[53,979,980],{},"CliRunner",", in a pipe, or with ",[53,983,984],{},"NO_COLOR"," set, the boxes remain but colours and styles are dropped, and markup tags are stripped rather than printed — which is why the examples above show ",[53,987,988],{},"Deploy SERVICE"," without the ",[53,991,704],{}," tags. Width follows the terminal, or ",[53,994,995],{},"COLUMNS"," when set. Very narrow terminals wrap the panels heavily; if many users run your tool in narrow CI logs, test help at 80 columns, as in ",[27,998,1000],{"href":999},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width\u002F","adapting output to terminal width",[665,1002],{"name":1003},"panels-terminal",[38,1005,1007],{"id":1006},"ux-considerations","UX considerations",[43,1009,1010,1016,1022,1036,1042],{},[46,1011,1012,1015],{},[14,1013,1014],{},"Group by task, not by type."," \"Target\", \"Safety\", \"Output\" beat \"String options\" and \"Flags\".",[46,1017,1018,1021],{},[14,1019,1020],{},"Three to five panels at most."," More boxes than that is a different kind of wall.",[46,1023,1024,1027,1028,1031,1032,1035],{},[14,1025,1026],{},"Keep the most dangerous switches visible."," A \"Safety\" panel with ",[53,1029,1030],{},"--dry-run"," and ",[53,1033,1034],{},"--yes"," near the end of the help is easy to find and hard to miss.",[46,1037,1038,1041],{},[14,1039,1040],{},"Never encode meaning in colour alone."," Colour is lost in pipes, logs and for colour-blind users; the words must carry the message.",[46,1043,1044,1047,1048,1051],{},[14,1045,1046],{},"Escape literal brackets"," in ",[53,1049,1050],{},"rich"," mode, or switch that string to plain text.",[38,1053,1055],{"id":1054},"testing-the-behaviour","Testing the behaviour",[10,1057,1058],{},"Pin the layout by rendering help at a fixed width and checking the panel order and placement:",[66,1060,1062],{"className":68,"code":1061,"language":70,"meta":71,"style":71},"# tests\u002Ftest_help_panels.py\nimport re\n\nfrom typer.testing import CliRunner\n\nfrom mytool.cli import app\n\nrunner = CliRunner()\nENV = {\"COLUMNS\": \"72\", \"NO_COLOR\": \"1\"}\n\n\ndef panels(text: str) -> list[str]:\n    return re.findall(r\"╭─ (.+?) ─\", text)\n\n\ndef test_command_panels_in_order():\n    assert panels(runner.invoke(app, [\"--help\"], env=ENV).output) == [\n        \"Options\", \"Deploying\", \"Inspecting\"]\n\n\ndef test_option_panels_for_deploy():\n    output = runner.invoke(app, [\"deploy\", \"--help\"], env=ENV).output\n    assert panels(output) == [\"Arguments\", \"Options\", \"Target\", \"Safety\"]\n    safety = output.split(\"╭─ Safety\")[1]\n    assert \"--dry-run\" in safety and \"--yes\" in safety\n\n\ndef test_markup_is_stripped_not_printed():\n    output = runner.invoke(app, [\"deploy\", \"--help\"], env=ENV).output\n    assert \"[bold]\" not in output and \"Deploy SERVICE to an environment.\" in output\n",[53,1063,1064,1069,1076,1080,1092,1096,1108,1112,1122,1155,1159,1163,1183,1218,1222,1226,1236,1266,1282,1286,1290,1299,1327,1357,1378,1402,1406,1410,1419,1443],{"__ignoreMap":71},[75,1065,1066],{"class":77,"line":78},[75,1067,1068],{"class":81},"# tests\u002Ftest_help_panels.py\n",[75,1070,1071,1073],{"class":77,"line":85},[75,1072,96],{"class":88},[75,1074,1075],{"class":92}," re\n",[75,1077,1078],{"class":77,"line":102},[75,1079,106],{"emptyLinePlaceholder":105},[75,1081,1082,1084,1087,1089],{"class":77,"line":109},[75,1083,89],{"class":88},[75,1085,1086],{"class":92}," typer.testing ",[75,1088,96],{"class":88},[75,1090,1091],{"class":92}," CliRunner\n",[75,1093,1094],{"class":77,"line":117},[75,1095,106],{"emptyLinePlaceholder":105},[75,1097,1098,1100,1103,1105],{"class":77,"line":122},[75,1099,89],{"class":88},[75,1101,1102],{"class":92}," mytool.cli ",[75,1104,96],{"class":88},[75,1106,1107],{"class":92}," app\n",[75,1109,1110],{"class":77,"line":134},[75,1111,106],{"emptyLinePlaceholder":105},[75,1113,1114,1117,1119],{"class":77,"line":150},[75,1115,1116],{"class":92},"runner ",[75,1118,128],{"class":88},[75,1120,1121],{"class":92}," CliRunner()\n",[75,1123,1124,1127,1130,1133,1136,1139,1142,1144,1147,1149,1152],{"class":77,"line":163},[75,1125,1126],{"class":214},"ENV",[75,1128,1129],{"class":88}," =",[75,1131,1132],{"class":92}," {",[75,1134,1135],{"class":143},"\"COLUMNS\"",[75,1137,1138],{"class":92},": ",[75,1140,1141],{"class":143},"\"72\"",[75,1143,308],{"class":92},[75,1145,1146],{"class":143},"\"NO_COLOR\"",[75,1148,1138],{"class":92},[75,1150,1151],{"class":143},"\"1\"",[75,1153,1154],{"class":92},"}\n",[75,1156,1157],{"class":77,"line":176},[75,1158,106],{"emptyLinePlaceholder":105},[75,1160,1161],{"class":77,"line":182},[75,1162,106],{"emptyLinePlaceholder":105},[75,1164,1165,1167,1170,1173,1175,1178,1180],{"class":77,"line":187},[75,1166,205],{"class":88},[75,1168,1169],{"class":195}," panels",[75,1171,1172],{"class":92},"(text: ",[75,1174,273],{"class":214},[75,1176,1177],{"class":92},") -> list[",[75,1179,273],{"class":214},[75,1181,1182],{"class":92},"]:\n",[75,1184,1185,1188,1191,1194,1197,1201,1204,1207,1210,1213,1215],{"class":77,"line":192},[75,1186,1187],{"class":88},"    return",[75,1189,1190],{"class":92}," re.findall(",[75,1192,1193],{"class":88},"r",[75,1195,1196],{"class":143},"\"",[75,1198,1200],{"class":1199},"sA_wV","╭─ ",[75,1202,1203],{"class":214},"(.",[75,1205,1206],{"class":88},"+?",[75,1208,1209],{"class":214},")",[75,1211,1212],{"class":1199}," ─",[75,1214,1196],{"class":143},[75,1216,1217],{"class":92},", text)\n",[75,1219,1220],{"class":77,"line":202},[75,1221,106],{"emptyLinePlaceholder":105},[75,1223,1224],{"class":77,"line":221},[75,1225,106],{"emptyLinePlaceholder":105},[75,1227,1228,1230,1233],{"class":77,"line":227},[75,1229,205],{"class":88},[75,1231,1232],{"class":195}," test_command_panels_in_order",[75,1234,1235],{"class":92},"():\n",[75,1237,1238,1241,1244,1247,1250,1253,1255,1257,1260,1263],{"class":77,"line":232},[75,1239,1240],{"class":88},"    assert",[75,1242,1243],{"class":92}," panels(runner.invoke(app, [",[75,1245,1246],{"class":143},"\"--help\"",[75,1248,1249],{"class":92},"], ",[75,1251,1252],{"class":137},"env",[75,1254,128],{"class":88},[75,1256,1126],{"class":214},[75,1258,1259],{"class":92},").output) ",[75,1261,1262],{"class":88},"==",[75,1264,1265],{"class":92}," [\n",[75,1267,1268,1271,1273,1275,1277,1279],{"class":77,"line":237},[75,1269,1270],{"class":143},"        \"Options\"",[75,1272,308],{"class":92},[75,1274,251],{"class":143},[75,1276,308],{"class":92},[75,1278,572],{"class":143},[75,1280,1281],{"class":92},"]\n",[75,1283,1284],{"class":77,"line":256},[75,1285,106],{"emptyLinePlaceholder":105},[75,1287,1288],{"class":77,"line":267},[75,1289,106],{"emptyLinePlaceholder":105},[75,1291,1292,1294,1297],{"class":77,"line":290},[75,1293,205],{"class":88},[75,1295,1296],{"class":195}," test_option_panels_for_deploy",[75,1298,1235],{"class":92},[75,1300,1301,1304,1306,1309,1312,1314,1316,1318,1320,1322,1324],{"class":77,"line":328},[75,1302,1303],{"class":92},"    output ",[75,1305,128],{"class":88},[75,1307,1308],{"class":92}," runner.invoke(app, [",[75,1310,1311],{"class":143},"\"deploy\"",[75,1313,308],{"class":92},[75,1315,1246],{"class":143},[75,1317,1249],{"class":92},[75,1319,1252],{"class":137},[75,1321,128],{"class":88},[75,1323,1126],{"class":214},[75,1325,1326],{"class":92},").output\n",[75,1328,1329,1331,1334,1336,1339,1342,1344,1347,1349,1351,1353,1355],{"class":77,"line":362},[75,1330,1240],{"class":88},[75,1332,1333],{"class":92}," panels(output) ",[75,1335,1262],{"class":88},[75,1337,1338],{"class":92}," [",[75,1340,1341],{"class":143},"\"Arguments\"",[75,1343,308],{"class":92},[75,1345,1346],{"class":143},"\"Options\"",[75,1348,308],{"class":92},[75,1350,315],{"class":143},[75,1352,308],{"class":92},[75,1354,399],{"class":143},[75,1356,1281],{"class":92},[75,1358,1359,1362,1364,1367,1370,1373,1376],{"class":77,"line":374},[75,1360,1361],{"class":92},"    safety ",[75,1363,128],{"class":88},[75,1365,1366],{"class":92}," output.split(",[75,1368,1369],{"class":143},"\"╭─ Safety\"",[75,1371,1372],{"class":92},")[",[75,1374,1375],{"class":214},"1",[75,1377,1281],{"class":92},[75,1379,1380,1382,1385,1388,1391,1394,1397,1399],{"class":77,"line":391},[75,1381,1240],{"class":88},[75,1383,1384],{"class":143}," \"--dry-run\"",[75,1386,1387],{"class":88}," in",[75,1389,1390],{"class":92}," safety ",[75,1392,1393],{"class":88},"and",[75,1395,1396],{"class":143}," \"--yes\"",[75,1398,1387],{"class":88},[75,1400,1401],{"class":92}," safety\n",[75,1403,1404],{"class":77,"line":411},[75,1405,106],{"emptyLinePlaceholder":105},[75,1407,1408],{"class":77,"line":421},[75,1409,106],{"emptyLinePlaceholder":105},[75,1411,1412,1414,1417],{"class":77,"line":457},[75,1413,205],{"class":88},[75,1415,1416],{"class":195}," test_markup_is_stripped_not_printed",[75,1418,1235],{"class":92},[75,1420,1421,1423,1425,1427,1429,1431,1433,1435,1437,1439,1441],{"class":77,"line":467},[75,1422,1303],{"class":92},[75,1424,128],{"class":88},[75,1426,1308],{"class":92},[75,1428,1311],{"class":143},[75,1430,308],{"class":92},[75,1432,1246],{"class":143},[75,1434,1249],{"class":92},[75,1436,1252],{"class":137},[75,1438,128],{"class":88},[75,1440,1126],{"class":214},[75,1442,1326],{"class":92},[75,1444,1445,1447,1450,1453,1455,1458,1460,1463,1465],{"class":77,"line":473},[75,1446,1240],{"class":88},[75,1448,1449],{"class":143}," \"[bold]\"",[75,1451,1452],{"class":88}," not",[75,1454,1387],{"class":88},[75,1456,1457],{"class":92}," output ",[75,1459,1393],{"class":88},[75,1461,1462],{"class":143}," \"Deploy SERVICE to an environment.\"",[75,1464,1387],{"class":88},[75,1466,1467],{"class":92}," output\n",[10,1469,1470,1471,1475],{},"Asserting on panel titles rather than whole screens keeps the tests stable across small Typer formatting changes, while still catching an option that drifted into the wrong box. A full snapshot, as in ",[27,1472,1474],{"href":1473},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output\u002F","snapshot testing CLI output",", is the stricter alternative.",[38,1477,1479],{"id":1478},"conclusion","Conclusion",[10,1481,1482,1483,1485,1486,1488,1489,1491],{},"A few keyword arguments make Typer's help scannable: ",[53,1484,246],{}," to group commands and options by task, one consistent ",[53,1487,691],{}," with light, meaningful markup, an ",[53,1490,24],{}," for links and examples, and pretty exceptions configured never to show locals. Remember that colour disappears outside a terminal so words must carry the meaning, and test panel order and placement at a fixed width so the structure survives future changes.",[38,1493,1495],{"id":1494},"frequently-asked-questions","Frequently asked questions",[669,1497,1499],{"id":1498},"can-i-use-help-panels-with-plain-click","Can I use help panels with plain Click?",[10,1501,1502,1503,1506,1507,36],{},"Not natively; panels are a Typer feature built on Rich. The ",[53,1504,1505],{},"rich-click"," package adds similar grouping to Click applications, as covered in ",[27,1508,1510],{"href":1509},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Frich-formatted-help-with-rich-click\u002F","Rich-formatted help with rich-click",[669,1512,1514],{"id":1513},"how-do-i-turn-off-rich-formatting-entirely","How do I turn off Rich formatting entirely?",[10,1516,1517,1518,1521],{},"Set ",[53,1519,1520],{},"rich_markup_mode=None"," for plain-text help strings. Typer still draws boxes when Rich is installed; for completely plain help, many teams keep the Rich layout for terminals and rely on Rich's automatic simplification in pipes and logs.",[669,1523,1525],{"id":1524},"why-do-my-square-brackets-disappear-from-help","Why do my square brackets disappear from help?",[10,1527,1528,1529,1531,1532,1535],{},"In ",[53,1530,1050],{}," mode they are parsed as markup tags. Escape them with a backslash (",[53,1533,1534],{},"\\[default]",") or move that text to an epilog in a different mode.",[669,1537,1539],{"id":1538},"do-panels-affect-shell-completion","Do panels affect shell completion?",[10,1541,1542],{},"No. Completion sees the same commands and options regardless of how help groups them.",[669,1544,1546],{"id":1545},"should-options-be-sorted-alphabetically-within-a-panel","Should options be sorted alphabetically within a panel?",[10,1548,1549],{},"Typer keeps declaration order, which is usually better than alphabetical: put the option most people need first and related options next to each other. Alphabetical order helps only when a panel has many similar options, such as a long list of output toggles.",[38,1551,1553],{"id":1552},"related","Related",[43,1555,1556,1562,1567,1573,1578],{},[46,1557,1558,1559],{},"Up: ",[27,1560,1561],{"href":29},"Typer vs Click: when to use each",[46,1563,1564],{},[27,1565,1566],{"href":59},"Using Annotated options in Typer",[46,1568,1569],{},[27,1570,1572],{"href":1571},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained\u002F","Typer callback functions explained",[46,1574,1575],{},[27,1576,1577],{"href":34},"Writing help text users actually read",[46,1579,1580],{},[27,1581,1583],{"href":1582},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently\u002F","Theming Rich output consistently",[1585,1586,1587],"style",{},"html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}html pre.shiki code .szBVR, html code.shiki .szBVR{--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .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 pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sA_wV, html code.shiki .sA_wV{--shiki-default:#032F62;--shiki-dark:#DBEDFF}",{"title":71,"searchDepth":85,"depth":85,"links":1589},[1590,1591,1597,1598,1599,1600,1601,1602,1609],{"id":40,"depth":85,"text":41},{"id":63,"depth":85,"text":64,"children":1592},[1593,1594,1595,1596],{"id":671,"depth":102,"text":672},{"id":685,"depth":102,"text":686},{"id":758,"depth":102,"text":759},{"id":778,"depth":102,"text":779},{"id":878,"depth":85,"text":879},{"id":973,"depth":85,"text":974},{"id":1006,"depth":85,"text":1007},{"id":1054,"depth":85,"text":1055},{"id":1478,"depth":85,"text":1479},{"id":1494,"depth":85,"text":1495,"children":1603},[1604,1605,1606,1607,1608],{"id":1498,"depth":102,"text":1499},{"id":1513,"depth":102,"text":1514},{"id":1524,"depth":102,"text":1525},{"id":1538,"depth":102,"text":1539},{"id":1545,"depth":102,"text":1546},{"id":1552,"depth":85,"text":1553},"2026-10-02","Organise Typer help into panels for commands and options, use Rich markup in help text, add epilogs, and configure pretty exceptions safely — with tests that pin the layout.","beginner",false,"md",{},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Frich-markup-and-help-panels-in-typer",{"title":5,"description":1611},"modern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Frich-markup-and-help-panels-in-typer\u002Findex",[1620,1050,1621,1622,1623],"typer","help-text","ux","formatting","YMk8di79m0VG5riIC75XbI0Vp_4nOTnd4U5li0fTBq8",[1626,1629,1632,1635,1638,1641,1644,1647,1650,1653,1656,1659,1662,1665,1668,1671,1674,1677,1680,1683,1686,1689,1692,1695,1698,1701,1704,1707,1710,1713,1716,1719,1722,1725,1728,1731,1734,1737,1740,1743,1746,1749,1752,1755,1758,1761,1764,1767,1770,1773,1776,1779,1782,1785,1788,1791,1794,1797,1800,1803,1806,1809,1812,1815,1818,1821,1824,1827,1830,1833,1836,1839,1842,1845,1848,1851,1854,1857,1860,1863,1866,1869,1872,1875,1878,1881,1884,1887,1890,1893,1896,1899,1902,1905,1908,1911,1914,1917,1920,1923,1926,1929,1932,1935,1938,1941,1944,1947,1950,1953,1956,1959,1962,1965,1968,1971,1974,1977,1980,1983,1986,1989,1992,1995,1998,2001,2004,2007,2010,2013,2016,2019,2022,2025,2028,2031,2034,2037,2040,2043,2046,2049,2052,2055,2058,2061,2064,2067,2070,2073,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,2224,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],{"path":1627,"title":1628},"\u002Fabout","About Python CLI Toolcraft",{"path":1630,"title":1631},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":1633,"title":1634},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":1636,"title":1637},"\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":1639,"title":1640},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":1642,"title":1643},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":1645,"title":1646},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-urls-hosts-and-ports","Validating URLs, Hosts and Ports in Python CLI Arguments",{"path":1648,"title":1649},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":1651,"title":1652},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbrowsing-records-with-a-textual-datatable","Browsing Records with a Textual DataTable Picker",{"path":1654,"title":1655},"\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":1657,"title":1658},"\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":1660,"title":1661},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":1663,"title":1664},"\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":1666,"title":1667},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fstyling-textual-apps-with-tcss","Styling Textual Apps with TCSS",{"path":1669,"title":1670},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":1672,"title":1673},"\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":1675,"title":1676},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fdocumenting-environment-variables-in-help","Documenting Environment Variables in CLI Help",{"path":1678,"title":1679},"\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":1681,"title":1682},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":1684,"title":1685},"\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":1687,"title":1688},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":1690,"title":1691},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":1693,"title":1694},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":1696,"title":1697},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":1699,"title":1700},"\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":1702,"title":1703},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fhandling-ansi-escape-codes-on-windows-consoles","Handling ANSI Escape Codes on Windows Consoles",{"path":1705,"title":1706},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":1708,"title":1709},"\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":1711,"title":1712},"\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":1714,"title":1715},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":1717,"title":1718},"\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":1720,"title":1721},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fdid-you-mean-suggestions-for-mistyped-input","Did You Mean…? Suggestions for Mistyped CLI Input",{"path":1723,"title":1724},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":1726,"title":1727},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":1729,"title":1730},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":1732,"title":1733},"\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":1735,"title":1736},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fwriting-crash-reports-users-can-send","Writing Crash Reports Users Can Send",{"path":1738,"title":1739},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":1741,"title":1742},"\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":1744,"title":1745},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":1747,"title":1748},"\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":1750,"title":1751},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":1753,"title":1754},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":1756,"title":1757},"\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":1759,"title":1760},"\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":1762,"title":1763},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":1765,"title":1766},"\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":1768,"title":1769},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":1771,"title":1772},"\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":1774,"title":1775},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":1777,"title":1778},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":1780,"title":1781},"\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":1783,"title":1784},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":1786,"title":1787},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":1789,"title":1790},"\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":1792,"title":1793},"\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":1795,"title":1796},"\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":1798,"title":1799},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis","Output Formats for Data-Heavy Python CLIs",{"path":1801,"title":1802},"\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":1804,"title":1805},"\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":1807,"title":1808},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fargcomplete-for-argparse-clis","Tab Completion for argparse CLIs with argcomplete",{"path":1810,"title":1811},"\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":1813,"title":1814},"\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":1816,"title":1817},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":1819,"title":1820},"\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":1822,"title":1823},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages","Shipping Shell Completion Scripts with a Python CLI",{"path":1825,"title":1826},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":1828,"title":1829},"\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":1831,"title":1832},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":1834,"title":1835},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":1837,"title":1838},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Flogging-with-structlog-in-a-cli","Logging with structlog in a Python CLI",{"path":1840,"title":1841},"\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":1843,"title":1844},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":1846,"title":1847},"\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":1849,"title":1850},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":1852,"title":1853},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":1855,"title":1856},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":1858,"title":1859},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":1861,"title":1862},"\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":1864,"title":1865},"\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":1867,"title":1868},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":1870,"title":1871},"\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":1873,"title":1874},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":1876,"title":1877},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":1879,"title":1880},"\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":1882,"title":1883},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":1885,"title":1886},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":1888,"title":1889},"\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":1891,"title":1892},"\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":1894,"title":1895},"\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":1897,"title":1898},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":1900,"title":1901},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":1903,"title":1904},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":1906,"title":1907},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":1909,"title":1910},"\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":1912,"title":1913},"\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":1915,"title":1916},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fstructured-concurrency-with-taskgroups-in-clis","Structured Concurrency with TaskGroups in Python CLIs",{"path":1918,"title":1919},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":1921,"title":1922},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":1924,"title":1925},"\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":1927,"title":1928},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":1930,"title":1931},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":1933,"title":1934},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":1936,"title":1937},"\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":1939,"title":1940},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":1942,"title":1943},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":1945,"title":1946},"\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":1948,"title":1949},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis","Local State and SQLite in Python CLIs",{"path":1951,"title":1952},"\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":1954,"title":1955},"\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":1957,"title":1958},"\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":1960,"title":1961},"\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":1963,"title":1964},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":1966,"title":1967},"\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":1969,"title":1970},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":1972,"title":1973},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Freloading-config-on-sighup","Reloading Configuration on SIGHUP in a Python CLI",{"path":1975,"title":1976},"\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":1978,"title":1979},"\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":1981,"title":1982},"\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":1984,"title":1985},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":1987,"title":1988},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":1990,"title":1991},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":1993,"title":1994},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":1996,"title":1997},"\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":1999,"title":2000},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fpiping-between-subprocesses-in-python","Piping Between Subprocesses in Python Without a Shell",{"path":2002,"title":2003},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":2005,"title":2006},"\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":2008,"title":2009},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":2011,"title":2012},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":2014,"title":2015},"\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":2017,"title":2018},"\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":2020,"title":2021},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Frefreshing-expired-tokens-automatically","Refreshing Expired Tokens Automatically in a Python CLI",{"path":2023,"title":2024},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":2026,"title":2027},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":2029,"title":2030},"\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":2032,"title":2033},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis","Update Checks, Upgrade Commands and Telemetry for Python CLIs",{"path":2035,"title":2036},"\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":2038,"title":2039},"\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":2041,"title":2042},"\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":2044,"title":2045},"\u002F","Python CLI Toolcraft",{"path":2047,"title":2048},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo","Building a Python CLI with Cleo Command Classes",{"path":2050,"title":2051},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts","Building a Type-Hinted Python CLI with Cyclopts",{"path":2053,"title":2054},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks","Beyond Click and Typer: Alternative Python CLI Frameworks",{"path":2056,"title":2057},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fquick-clis-from-functions-with-python-fire","Quick CLIs from Functions with Python Fire",{"path":2059,"title":2060},"\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":2062,"title":2063},"\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":2065,"title":2066},"\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":2068,"title":2069},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fguarding-startup-with-import-tests","Guarding CLI Startup with Import Tests",{"path":2071,"title":2072},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":2074,"title":2075},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":2077,"title":2078},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":2080,"title":2081},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":2083,"title":2084},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":2086,"title":2087},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":2089,"title":2090},"\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":2092,"title":2093},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":2095,"title":2096},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":2098,"title":2099},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":2101,"title":2102},"\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":2104,"title":2105},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":2107,"title":2108},"\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":2110,"title":2111},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fdesigning-idempotent-commands","Designing Idempotent Commands in a Python CLI",{"path":2113,"title":2114},"\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":2116,"title":2117},"\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":2119,"title":2120},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":2122,"title":2123},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":2125,"title":2126},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fpositional-arguments-vs-options","Positional Arguments vs Options: Designing a CLI Signature",{"path":2128,"title":2129},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":2131,"title":2132},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":2134,"title":2135},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":2137,"title":2138},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":2140,"title":2141},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures","Isolating Plugin Failures in an Extensible Python CLI",{"path":2143,"title":2144},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli","Testing Plugins Against the Host CLI",{"path":2146,"title":2147},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":2149,"title":2150},"\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":2152,"title":2153},"\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":2155,"title":2156},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":2158,"title":2159},"\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":2161,"title":2162},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":2164,"title":2165},"\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":2167,"title":2168},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically","Registering CLI Commands from Modules Automatically",{"path":2170,"title":2171},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":2173,"title":2174},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":2176,"title":2177},"\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":2179,"title":2180},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":2182,"title":2183},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":2185,"title":2186},"\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":2188,"title":2189},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":2191,"title":2192},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":2194,"title":2195},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":2197,"title":2198},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-commands-that-call-subprocesses","Testing Python CLI Commands That Call Subprocesses",{"path":2200,"title":2201},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":2203,"title":2204},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands","Transcript Tests for Python CLI Commands",{"path":2206,"title":2207},"\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":2209,"title":2210},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":2212,"title":2213},"\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":2215,"title":2216},"\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":2218,"title":2219},"\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":2221,"title":2222},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":1616,"title":5},{"path":2225,"title":1572},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained",{"path":2227,"title":2228},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":2230,"title":2231},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":2233,"title":2234},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":2236,"title":2237},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":2239,"title":2240},"\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":2242,"title":2243},"\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":2245,"title":2246},"\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":2248,"title":2249},"\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":2251,"title":2252},"\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":2254,"title":2255},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":2257,"title":2258},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":2260,"title":2261},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":2263,"title":2264},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":2266,"title":2267},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftemplate-variables-and-conditional-files","Template Variables and Conditional Files in CLI Templates",{"path":2269,"title":2270},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftesting-a-project-template-with-pytest","Testing a CLI Project Template with pytest",{"path":2272,"title":2273},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fupdating-generated-projects-with-copier-update","Updating Generated CLI Projects with copier update",{"path":2275,"title":2276},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":2278,"title":2279},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":2281,"title":2282},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fcode-signing-and-notarizing-cli-binaries","Code Signing and Notarizing Python CLI Binaries",{"path":2284,"title":2285},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":2287,"title":2288},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":2290,"title":2291},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":2293,"title":2294},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Freducing-pyinstaller-binary-size","Reducing the Size of a PyInstaller CLI Binary",{"path":2296,"title":2297},"\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":2299,"title":2300},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":2302,"title":2303},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":2305,"title":2306},"\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":2308,"title":2309},"\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":2311,"title":2312},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":2314,"title":2315},"\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":2317,"title":2318},"\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":2320,"title":2321},"\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":2323,"title":2324},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":2326,"title":2327},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fbumping-versions-consistently-across-a-cli-project","Bumping Versions Consistently Across a Python CLI Project",{"path":2329,"title":2330},"\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":2332,"title":2333},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":2335,"title":2336},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":2338,"title":2339},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":2341,"title":2342},"\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":2344,"title":2345},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":2347,"title":2348},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":2350,"title":2351},"\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":2353,"title":2354},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":2356,"title":2357},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":2359,"title":2360},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Foptional-dependencies-and-extras-for-clis","Optional Dependencies and Extras for Python CLIs",{"path":2362,"title":2363},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":2365,"title":2366},"\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":2368,"title":2369},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fdynamic-versioning-with-poetry-plugins","Dynamic Versioning for a Poetry CLI from Git Tags",{"path":2371,"title":2372},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":2374,"title":2375},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmanaging-poetry-lock-files-for-cli-tools","Managing Poetry Lock Files for CLI Tools",{"path":2377,"title":2378},"\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":2380,"title":2381},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":2383,"title":2384},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":2386,"title":2387},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpublishing-a-cli-with-poetry","Building and Publishing a Python CLI with Poetry",{"path":2389,"title":2390},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":2392,"title":2393},"\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":2395,"title":2396},"\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":2398,"title":2399},"\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":2401,"title":2402},"\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":2404,"title":2405},"\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":2407,"title":2408},"\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":2410,"title":2411},"\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":2413,"title":2414},"\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":2416,"title":2417},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain","Securing the Supply Chain of a Python CLI",{"path":2419,"title":2420},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpinning-dependencies-with-hashes","Pinning a Python CLI’s Dependencies with Hashes",{"path":2422,"title":2423},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpublishing-attestations-and-verifying-releases","Publishing Attestations and Verifying Python CLI Releases",{"path":2425,"title":2426},"\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":2428,"title":2429},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":2431,"title":2432},"\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":2434,"title":2435},"\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":2437,"title":2438},"\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":2440,"title":2441},"\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":2443,"title":2444},"\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":2446,"title":2447},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":2449,"title":2450},"\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":2452,"title":2453},"\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":2455,"title":2456},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":2458,"title":2459},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fisolating-cli-tools-from-project-dependencies","Isolating CLI Tools from Your Project’s Dependencies",{"path":2461,"title":2462},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":2464,"title":2465},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":2467,"title":2468},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1790967541930]