[{"data":1,"prerenderedAt":2541},["ShallowReactive",2],{"page-\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fchoosing-between-a-cli-a-prompt-flow-and-a-tui\u002F":3,"content-directory":1697},{"id":4,"title":5,"body":6,"date":1682,"description":1683,"difficulty":1684,"draft":1685,"extension":1686,"meta":1687,"navigation":187,"path":1688,"seo":1689,"stem":1690,"tags":1691,"updated":1682,"__hash__":1696},"content\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fchoosing-between-a-cli-a-prompt-flow-and-a-tui\u002Findex.md","Choosing Between a CLI, a Prompt Flow and a TUI",{"type":7,"value":8,"toc":1664},"minimark",[9,32,37,51,55,66,72,78,82,86,89,117,136,140,143,146,883,1090,1093,1152,1160,1164,1167,1170,1174,1211,1215,1222,1554,1568,1572,1575,1579,1591,1600,1604,1607,1611,1619,1623,1626,1630,1660],[10,11,12,13,17,18,21,22,25,26,31],"p",{},"When a Python tool starts growing, someone always asks for it to be \"more interactive\". Sometimes they mean prompts that walk a new user through setup; sometimes a full-screen dashboard with arrow-key navigation; sometimes just nicer output. Each of those is a different interface style with different costs, and picking the wrong one produces tools that are either tedious for daily use or impossible to automate. This guide compares the three styles a Python CLI can offer — ",[14,15,16],"strong",{},"plain commands",", ",[14,19,20],{},"prompt flows"," and ",[14,23,24],{},"full-screen TUIs"," — gives concrete criteria for choosing, and shows how to build them as layers over one core so you never have to choose only one. It belongs to the ",[27,28,30],"a",{"href":29},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002F","building terminal UIs with Textual topic",".",[33,34,36],"h2",{"id":35},"prerequisites","Prerequisites",[38,39,40,48],"ul",{},[41,42,43,44,31],"li",{},"A CLI built with Typer or Click, with its logic in core functions separate from the command layer, as described in ",[27,45,47],{"href":46},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fhow-to-structure-a-large-python-cli-project\u002F","how to structure a large Python CLI project",[41,49,50],{},"A specific task in mind. The right interface depends on the task, not the tool.",[33,52,54],{"id":53},"the-three-styles","The three styles",[10,56,57,60,61,65],{},[14,58,59],{},"Plain commands"," take everything as arguments and options, do their work, and print results. They are scriptable, repeatable, composable with pipes, documented by ",[62,63,64],"code",{},"--help",", and fast for people who know what they want. They are the foundation; every other style is optional.",[10,67,68,71],{},[14,69,70],{},"Prompt flows"," ask questions one at a time — \"Project name?\", \"Which template?\" — and are good for tasks done rarely and involving several choices: first-time setup, generating a config file, a release checklist. Done well, every prompt corresponds to a flag, so the same command can run unattended.",[10,73,74,77],{},[14,75,76],{},"Full-screen TUIs"," take over the terminal with an interactive, continuously updated view: lists to scroll, panels that update, keys that act on the selected item. They excel at exploring and monitoring — browsing hundreds of items, watching a queue, triaging alerts — and are useless for automation.",[33,79,81],{"id":80},"the-recipe-choosing-by-task","The recipe: choosing by task",[83,84],"inline-diagram",{"name":85},"choose-decision",[10,87,88],{},"Ask how the task is actually done:",[38,90,91,105,111],{},[41,92,93,96,97,100,101,31],{},[14,94,95],{},"Repeatedly, or by scripts and CI"," → a command. If people do it daily, every extra keystroke in a prompt or TUI is friction; if a machine does it, anything interactive is a bug. Machine-readable output (",[62,98,99],{},"--json",") belongs here too, as covered in ",[27,102,104],{"href":103},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting\u002F","emitting JSON output for scripting",[41,106,107,110],{},[14,108,109],{},"Rarely, with several decisions a newcomer will not know"," → a prompt flow, on top of a command that accepts the same answers as flags.",[41,112,113,116],{},[14,114,115],{},"Exploring or watching data whose shape the user does not know in advance"," → a TUI, on top of commands that expose the same data.",[10,118,119,120,123,124,127,128,131,132,135],{},"A few signals point the same way. If you find yourself writing documentation that says \"run ",[62,121,122],{},"list",", find the ID, then run ",[62,125,126],{},"show ID",", then ",[62,129,130],{},"rollback ID","\", a TUI or at least an interactive picker may help. If support questions are mostly \"what do I put in the config?\", a prompt flow for ",[62,133,134],{},"init"," will help more than a better README. If people wrap your command in shell loops, it is already doing its job as a command — do not make it interactive.",[33,137,139],{"id":138},"the-recipe-layering-so-you-never-choose-only-one","The recipe: layering, so you never choose only one",[83,141],{"name":142},"choose-layers",[10,144,145],{},"The best tools offer the styles as layers over one core, so each task gets the right interface and nothing is duplicated. The command is the base; prompts fill in only what flags did not provide; a TUI calls the same core functions and can hand results back to commands.",[147,148,153],"pre",{"className":149,"code":150,"language":151,"meta":152,"style":152},"language-python shiki shiki-themes github-light github-dark","# src\u002Fmytool\u002Fcli.py\nfrom __future__ import annotations\n\nimport sys\nfrom typing import Annotated\n\nimport typer\n\nfrom mytool.core import TEMPLATES, create_project\n\napp = typer.Typer()\n\n\ndef interactive() -> bool:\n    return sys.stdin.isatty() and sys.stdout.isatty()\n\n\n@app.callback()\ndef main() -> None:\n    \"\"\"Project tool with commands, guided prompts and an interactive picker.\"\"\"\n\n\n@app.command()\ndef init(\n    name: Annotated[str | None, typer.Option(help=\"Project name.\")] = None,\n    template: Annotated[str | None, typer.Option(help=f\"One of: {', '.join(TEMPLATES)}.\")] = None,\n    no_input: Annotated[bool, typer.Option(\"--no-input\", help=\"Never prompt; fail if values are missing.\")] = False,\n) -> None:\n    \"\"\"Create a project. Prompts for anything not given as an option.\"\"\"\n    can_ask = interactive() and not no_input\n    if name is None:\n        if not can_ask:\n            raise typer.BadParameter(\"required when not running interactively\", param_hint=\"--name\")\n        name = typer.prompt(\"Project name\")\n    if template is None:\n        if not can_ask:\n            template = \"basic\"                                   # a documented default\n        else:\n            template = typer.prompt(\"Template\", default=\"basic\",\n                                    type=typer.Choice(list(TEMPLATES)), show_choices=True)\n    path = create_project(name, template)\n    typer.echo(f\"created {path}\", err=True)\n\n\n@app.command()\ndef pick() -> None:\n    \"\"\"Choose a project interactively and print its name (for use in $(...)).\"\"\"\n    if not interactive():\n        typer.echo(\"error: pick needs a terminal; use 'mytool list' in scripts\", err=True)\n        raise typer.Exit(2)\n    from mytool.tui import ProjectPicker                         # Textual imported only here\n    chosen = ProjectPicker().run()\n    if chosen is None:\n        raise typer.Exit(1)\n    typer.echo(chosen)\n","python","",[62,154,155,164,182,189,198,211,216,224,229,245,250,262,267,272,291,306,311,316,325,340,347,352,357,365,376,413,466,497,507,513,532,548,559,584,600,614,623,637,645,669,700,711,743,748,753,760,774,780,790,809,823,840,851,865,877],{"__ignoreMap":152},[156,157,160],"span",{"class":158,"line":159},"line",1,[156,161,163],{"class":162},"sJ8bj","# src\u002Fmytool\u002Fcli.py\n",[156,165,167,171,175,178],{"class":158,"line":166},2,[156,168,170],{"class":169},"szBVR","from",[156,172,174],{"class":173},"sj4cs"," __future__",[156,176,177],{"class":169}," import",[156,179,181],{"class":180},"sVt8B"," annotations\n",[156,183,185],{"class":158,"line":184},3,[156,186,188],{"emptyLinePlaceholder":187},true,"\n",[156,190,192,195],{"class":158,"line":191},4,[156,193,194],{"class":169},"import",[156,196,197],{"class":180}," sys\n",[156,199,201,203,206,208],{"class":158,"line":200},5,[156,202,170],{"class":169},[156,204,205],{"class":180}," typing ",[156,207,194],{"class":169},[156,209,210],{"class":180}," Annotated\n",[156,212,214],{"class":158,"line":213},6,[156,215,188],{"emptyLinePlaceholder":187},[156,217,219,221],{"class":158,"line":218},7,[156,220,194],{"class":169},[156,222,223],{"class":180}," typer\n",[156,225,227],{"class":158,"line":226},8,[156,228,188],{"emptyLinePlaceholder":187},[156,230,232,234,237,239,242],{"class":158,"line":231},9,[156,233,170],{"class":169},[156,235,236],{"class":180}," mytool.core ",[156,238,194],{"class":169},[156,240,241],{"class":173}," TEMPLATES",[156,243,244],{"class":180},", create_project\n",[156,246,248],{"class":158,"line":247},10,[156,249,188],{"emptyLinePlaceholder":187},[156,251,253,256,259],{"class":158,"line":252},11,[156,254,255],{"class":180},"app ",[156,257,258],{"class":169},"=",[156,260,261],{"class":180}," typer.Typer()\n",[156,263,265],{"class":158,"line":264},12,[156,266,188],{"emptyLinePlaceholder":187},[156,268,270],{"class":158,"line":269},13,[156,271,188],{"emptyLinePlaceholder":187},[156,273,275,278,282,285,288],{"class":158,"line":274},14,[156,276,277],{"class":169},"def",[156,279,281],{"class":280},"sScJk"," interactive",[156,283,284],{"class":180},"() -> ",[156,286,287],{"class":173},"bool",[156,289,290],{"class":180},":\n",[156,292,294,297,300,303],{"class":158,"line":293},15,[156,295,296],{"class":169},"    return",[156,298,299],{"class":180}," sys.stdin.isatty() ",[156,301,302],{"class":169},"and",[156,304,305],{"class":180}," sys.stdout.isatty()\n",[156,307,309],{"class":158,"line":308},16,[156,310,188],{"emptyLinePlaceholder":187},[156,312,314],{"class":158,"line":313},17,[156,315,188],{"emptyLinePlaceholder":187},[156,317,319,322],{"class":158,"line":318},18,[156,320,321],{"class":280},"@app.callback",[156,323,324],{"class":180},"()\n",[156,326,328,330,333,335,338],{"class":158,"line":327},19,[156,329,277],{"class":169},[156,331,332],{"class":280}," main",[156,334,284],{"class":180},[156,336,337],{"class":173},"None",[156,339,290],{"class":180},[156,341,343],{"class":158,"line":342},20,[156,344,346],{"class":345},"sZZnC","    \"\"\"Project tool with commands, guided prompts and an interactive picker.\"\"\"\n",[156,348,350],{"class":158,"line":349},21,[156,351,188],{"emptyLinePlaceholder":187},[156,353,355],{"class":158,"line":354},22,[156,356,188],{"emptyLinePlaceholder":187},[156,358,360,363],{"class":158,"line":359},23,[156,361,362],{"class":280},"@app.command",[156,364,324],{"class":180},[156,366,368,370,373],{"class":158,"line":367},24,[156,369,277],{"class":169},[156,371,372],{"class":280}," init",[156,374,375],{"class":180},"(\n",[156,377,379,382,385,388,391,394,398,400,403,406,408,410],{"class":158,"line":378},25,[156,380,381],{"class":180},"    name: Annotated[",[156,383,384],{"class":173},"str",[156,386,387],{"class":169}," |",[156,389,390],{"class":173}," None",[156,392,393],{"class":180},", typer.Option(",[156,395,397],{"class":396},"s4XuR","help",[156,399,258],{"class":169},[156,401,402],{"class":345},"\"Project name.\"",[156,404,405],{"class":180},")] ",[156,407,258],{"class":169},[156,409,390],{"class":173},[156,411,412],{"class":180},",\n",[156,414,416,419,421,423,425,427,429,431,434,437,440,443,446,449,452,455,458,460,462,464],{"class":158,"line":415},26,[156,417,418],{"class":180},"    template: Annotated[",[156,420,384],{"class":173},[156,422,387],{"class":169},[156,424,390],{"class":173},[156,426,393],{"class":180},[156,428,397],{"class":396},[156,430,258],{"class":169},[156,432,433],{"class":169},"f",[156,435,436],{"class":345},"\"One of: ",[156,438,439],{"class":173},"{",[156,441,442],{"class":345},"', '",[156,444,445],{"class":180},".join(",[156,447,448],{"class":173},"TEMPLATES",[156,450,451],{"class":180},")",[156,453,454],{"class":173},"}",[156,456,457],{"class":345},".\"",[156,459,405],{"class":180},[156,461,258],{"class":169},[156,463,390],{"class":173},[156,465,412],{"class":180},[156,467,469,472,474,476,479,481,483,485,488,490,492,495],{"class":158,"line":468},27,[156,470,471],{"class":180},"    no_input: Annotated[",[156,473,287],{"class":173},[156,475,393],{"class":180},[156,477,478],{"class":345},"\"--no-input\"",[156,480,17],{"class":180},[156,482,397],{"class":396},[156,484,258],{"class":169},[156,486,487],{"class":345},"\"Never prompt; fail if values are missing.\"",[156,489,405],{"class":180},[156,491,258],{"class":169},[156,493,494],{"class":173}," False",[156,496,412],{"class":180},[156,498,500,503,505],{"class":158,"line":499},28,[156,501,502],{"class":180},") -> ",[156,504,337],{"class":173},[156,506,290],{"class":180},[156,508,510],{"class":158,"line":509},29,[156,511,512],{"class":345},"    \"\"\"Create a project. Prompts for anything not given as an option.\"\"\"\n",[156,514,516,519,521,524,526,529],{"class":158,"line":515},30,[156,517,518],{"class":180},"    can_ask ",[156,520,258],{"class":169},[156,522,523],{"class":180}," interactive() ",[156,525,302],{"class":169},[156,527,528],{"class":169}," not",[156,530,531],{"class":180}," no_input\n",[156,533,535,538,541,544,546],{"class":158,"line":534},31,[156,536,537],{"class":169},"    if",[156,539,540],{"class":180}," name ",[156,542,543],{"class":169},"is",[156,545,390],{"class":173},[156,547,290],{"class":180},[156,549,551,554,556],{"class":158,"line":550},32,[156,552,553],{"class":169},"        if",[156,555,528],{"class":169},[156,557,558],{"class":180}," can_ask:\n",[156,560,562,565,568,571,573,576,578,581],{"class":158,"line":561},33,[156,563,564],{"class":169},"            raise",[156,566,567],{"class":180}," typer.BadParameter(",[156,569,570],{"class":345},"\"required when not running interactively\"",[156,572,17],{"class":180},[156,574,575],{"class":396},"param_hint",[156,577,258],{"class":169},[156,579,580],{"class":345},"\"--name\"",[156,582,583],{"class":180},")\n",[156,585,587,590,592,595,598],{"class":158,"line":586},34,[156,588,589],{"class":180},"        name ",[156,591,258],{"class":169},[156,593,594],{"class":180}," typer.prompt(",[156,596,597],{"class":345},"\"Project name\"",[156,599,583],{"class":180},[156,601,603,605,608,610,612],{"class":158,"line":602},35,[156,604,537],{"class":169},[156,606,607],{"class":180}," template ",[156,609,543],{"class":169},[156,611,390],{"class":173},[156,613,290],{"class":180},[156,615,617,619,621],{"class":158,"line":616},36,[156,618,553],{"class":169},[156,620,528],{"class":169},[156,622,558],{"class":180},[156,624,626,629,631,634],{"class":158,"line":625},37,[156,627,628],{"class":180},"            template ",[156,630,258],{"class":169},[156,632,633],{"class":345}," \"basic\"",[156,635,636],{"class":162},"                                   # a documented default\n",[156,638,640,643],{"class":158,"line":639},38,[156,641,642],{"class":169},"        else",[156,644,290],{"class":180},[156,646,648,650,652,654,657,659,662,664,667],{"class":158,"line":647},39,[156,649,628],{"class":180},[156,651,258],{"class":169},[156,653,594],{"class":180},[156,655,656],{"class":345},"\"Template\"",[156,658,17],{"class":180},[156,660,661],{"class":396},"default",[156,663,258],{"class":169},[156,665,666],{"class":345},"\"basic\"",[156,668,412],{"class":180},[156,670,672,675,677,680,682,685,687,690,693,695,698],{"class":158,"line":671},40,[156,673,674],{"class":396},"                                    type",[156,676,258],{"class":169},[156,678,679],{"class":180},"typer.Choice(",[156,681,122],{"class":173},[156,683,684],{"class":180},"(",[156,686,448],{"class":173},[156,688,689],{"class":180},")), ",[156,691,692],{"class":396},"show_choices",[156,694,258],{"class":169},[156,696,697],{"class":173},"True",[156,699,583],{"class":180},[156,701,703,706,708],{"class":158,"line":702},41,[156,704,705],{"class":180},"    path ",[156,707,258],{"class":169},[156,709,710],{"class":180}," create_project(name, template)\n",[156,712,714,717,719,722,724,727,729,732,734,737,739,741],{"class":158,"line":713},42,[156,715,716],{"class":180},"    typer.echo(",[156,718,433],{"class":169},[156,720,721],{"class":345},"\"created ",[156,723,439],{"class":173},[156,725,726],{"class":180},"path",[156,728,454],{"class":173},[156,730,731],{"class":345},"\"",[156,733,17],{"class":180},[156,735,736],{"class":396},"err",[156,738,258],{"class":169},[156,740,697],{"class":173},[156,742,583],{"class":180},[156,744,746],{"class":158,"line":745},43,[156,747,188],{"emptyLinePlaceholder":187},[156,749,751],{"class":158,"line":750},44,[156,752,188],{"emptyLinePlaceholder":187},[156,754,756,758],{"class":158,"line":755},45,[156,757,362],{"class":280},[156,759,324],{"class":180},[156,761,763,765,768,770,772],{"class":158,"line":762},46,[156,764,277],{"class":169},[156,766,767],{"class":280}," pick",[156,769,284],{"class":180},[156,771,337],{"class":173},[156,773,290],{"class":180},[156,775,777],{"class":158,"line":776},47,[156,778,779],{"class":345},"    \"\"\"Choose a project interactively and print its name (for use in $(...)).\"\"\"\n",[156,781,783,785,787],{"class":158,"line":782},48,[156,784,537],{"class":169},[156,786,528],{"class":169},[156,788,789],{"class":180}," interactive():\n",[156,791,793,796,799,801,803,805,807],{"class":158,"line":792},49,[156,794,795],{"class":180},"        typer.echo(",[156,797,798],{"class":345},"\"error: pick needs a terminal; use 'mytool list' in scripts\"",[156,800,17],{"class":180},[156,802,736],{"class":396},[156,804,258],{"class":169},[156,806,697],{"class":173},[156,808,583],{"class":180},[156,810,812,815,818,821],{"class":158,"line":811},50,[156,813,814],{"class":169},"        raise",[156,816,817],{"class":180}," typer.Exit(",[156,819,820],{"class":173},"2",[156,822,583],{"class":180},[156,824,826,829,832,834,837],{"class":158,"line":825},51,[156,827,828],{"class":169},"    from",[156,830,831],{"class":180}," mytool.tui ",[156,833,194],{"class":169},[156,835,836],{"class":180}," ProjectPicker                         ",[156,838,839],{"class":162},"# Textual imported only here\n",[156,841,843,846,848],{"class":158,"line":842},52,[156,844,845],{"class":180},"    chosen ",[156,847,258],{"class":169},[156,849,850],{"class":180}," ProjectPicker().run()\n",[156,852,854,856,859,861,863],{"class":158,"line":853},53,[156,855,537],{"class":169},[156,857,858],{"class":180}," chosen ",[156,860,543],{"class":169},[156,862,390],{"class":173},[156,864,290],{"class":180},[156,866,868,870,872,875],{"class":158,"line":867},54,[156,869,814],{"class":169},[156,871,817],{"class":180},[156,873,874],{"class":173},"1",[156,876,583],{"class":180},[156,878,880],{"class":158,"line":879},55,[156,881,882],{"class":180},"    typer.echo(chosen)\n",[147,884,886],{"className":149,"code":885,"language":151,"meta":152,"style":152},"# src\u002Fmytool\u002Fcore.py\nfrom pathlib import Path\n\nTEMPLATES = {\"basic\": \"A minimal CLI\", \"service\": \"A CLI with an HTTP client\", \"data\": \"A data pipeline CLI\"}\n\n\ndef create_project(name: str, template: str) -> Path:\n    if template not in TEMPLATES:\n        raise ValueError(f\"unknown template {template!r}\")\n    path = Path(name)\n    path.mkdir(exist_ok=False)\n    (path \u002F \"TEMPLATE\").write_text(template + \"\\n\", encoding=\"utf-8\")\n    return path\n",[62,887,888,893,905,909,950,954,958,978,994,1022,1031,1046,1083],{"__ignoreMap":152},[156,889,890],{"class":158,"line":159},[156,891,892],{"class":162},"# src\u002Fmytool\u002Fcore.py\n",[156,894,895,897,900,902],{"class":158,"line":166},[156,896,170],{"class":169},[156,898,899],{"class":180}," pathlib ",[156,901,194],{"class":169},[156,903,904],{"class":180}," Path\n",[156,906,907],{"class":158,"line":184},[156,908,188],{"emptyLinePlaceholder":187},[156,910,911,913,916,919,921,924,927,929,932,934,937,939,942,944,947],{"class":158,"line":191},[156,912,448],{"class":173},[156,914,915],{"class":169}," =",[156,917,918],{"class":180}," {",[156,920,666],{"class":345},[156,922,923],{"class":180},": ",[156,925,926],{"class":345},"\"A minimal CLI\"",[156,928,17],{"class":180},[156,930,931],{"class":345},"\"service\"",[156,933,923],{"class":180},[156,935,936],{"class":345},"\"A CLI with an HTTP client\"",[156,938,17],{"class":180},[156,940,941],{"class":345},"\"data\"",[156,943,923],{"class":180},[156,945,946],{"class":345},"\"A data pipeline CLI\"",[156,948,949],{"class":180},"}\n",[156,951,952],{"class":158,"line":200},[156,953,188],{"emptyLinePlaceholder":187},[156,955,956],{"class":158,"line":213},[156,957,188],{"emptyLinePlaceholder":187},[156,959,960,962,965,968,970,973,975],{"class":158,"line":218},[156,961,277],{"class":169},[156,963,964],{"class":280}," create_project",[156,966,967],{"class":180},"(name: ",[156,969,384],{"class":173},[156,971,972],{"class":180},", template: ",[156,974,384],{"class":173},[156,976,977],{"class":180},") -> Path:\n",[156,979,980,982,984,987,990,992],{"class":158,"line":226},[156,981,537],{"class":169},[156,983,607],{"class":180},[156,985,986],{"class":169},"not",[156,988,989],{"class":169}," in",[156,991,241],{"class":173},[156,993,290],{"class":180},[156,995,996,998,1001,1003,1005,1008,1010,1013,1016,1018,1020],{"class":158,"line":231},[156,997,814],{"class":169},[156,999,1000],{"class":173}," ValueError",[156,1002,684],{"class":180},[156,1004,433],{"class":169},[156,1006,1007],{"class":345},"\"unknown template ",[156,1009,439],{"class":173},[156,1011,1012],{"class":180},"template",[156,1014,1015],{"class":169},"!r",[156,1017,454],{"class":173},[156,1019,731],{"class":345},[156,1021,583],{"class":180},[156,1023,1024,1026,1028],{"class":158,"line":247},[156,1025,705],{"class":180},[156,1027,258],{"class":169},[156,1029,1030],{"class":180}," Path(name)\n",[156,1032,1033,1036,1039,1041,1044],{"class":158,"line":252},[156,1034,1035],{"class":180},"    path.mkdir(",[156,1037,1038],{"class":396},"exist_ok",[156,1040,258],{"class":169},[156,1042,1043],{"class":173},"False",[156,1045,583],{"class":180},[156,1047,1048,1051,1054,1057,1060,1063,1066,1069,1071,1073,1076,1078,1081],{"class":158,"line":264},[156,1049,1050],{"class":180},"    (path ",[156,1052,1053],{"class":169},"\u002F",[156,1055,1056],{"class":345}," \"TEMPLATE\"",[156,1058,1059],{"class":180},").write_text(template ",[156,1061,1062],{"class":169},"+",[156,1064,1065],{"class":345}," \"",[156,1067,1068],{"class":173},"\\n",[156,1070,731],{"class":345},[156,1072,17],{"class":180},[156,1074,1075],{"class":396},"encoding",[156,1077,258],{"class":169},[156,1079,1080],{"class":345},"\"utf-8\"",[156,1082,583],{"class":180},[156,1084,1085,1087],{"class":158,"line":269},[156,1086,296],{"class":169},[156,1088,1089],{"class":180}," path\n",[10,1091,1092],{},"The design principles embedded here:",[38,1094,1095,1105,1111,1125,1142],{},[41,1096,1097,1100,1101,1104],{},[14,1098,1099],{},"Every prompt has a flag."," ",[62,1102,1103],{},"mytool init --name web --template service"," runs with no questions, so documentation, scripts and CI all use the same command a newcomer uses interactively.",[41,1106,1107,1110],{},[14,1108,1109],{},"Prompts only fill gaps."," A value given as a flag is never asked for again.",[41,1112,1113,1116,1117,1120,1121,31],{},[14,1114,1115],{},"No terminal, no prompts."," When stdin or stdout is not a terminal, or ",[62,1118,1119],{},"--no-input"," is set, the command either uses a documented default or fails immediately with the flag to use — it never hangs waiting for input. The same rule is covered from the security side in ",[27,1122,1124],{"href":1123},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely\u002F","prompting for passwords securely",[41,1126,1127,1100,1130,1133,1134,1137,1138,31],{},[14,1128,1129],{},"The TUI returns data.",[62,1131,1132],{},"pick"," prints the chosen name, so ",[62,1135,1136],{},"mytool open $(mytool pick)"," combines the TUI with ordinary commands. The picker itself can be as small as the one in ",[27,1139,1141],{"href":1140},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot\u002F","testing Textual apps with Pilot",[41,1143,1144,1147,1148,1151],{},[14,1145,1146],{},"One core."," Commands, prompts and the TUI all call ",[62,1149,1150],{},"create_project"," and friends; there is no second implementation to drift.",[10,1153,1154,1155,1159],{},"Richer prompt flows — menus, checkboxes, fuzzy selection — are covered in ",[27,1156,1158],{"href":1157},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus\u002F","building interactive prompts and menus","; the layering rules stay the same.",[33,1161,1163],{"id":1162},"what-each-style-costs","What each style costs",[83,1165],{"name":1166},"choose-costs",[10,1168,1169],{},"Commands are the cheapest to build and test and the most valuable to automate. Prompts add a modest amount of code and a testing burden for the interactive path. A TUI is a second user interface: it needs its own tests, has its own terminal-compatibility quirks, adds import time wherever it is loaded, and produces nothing a script can use. None of that argues against building one — for the right task a TUI is transformative — but it argues for building it last, on top of commands that already work.",[33,1171,1173],{"id":1172},"ux-considerations","UX considerations",[38,1175,1176,1182,1191,1197],{},[41,1177,1178,1181],{},[14,1179,1180],{},"Default to the least interactive style that serves the task."," Interactivity is a cost for experienced users; add it where newcomers or exploration genuinely need it.",[41,1183,1184,1187,1188,1190],{},[14,1185,1186],{},"Show the equivalent command."," After a prompt flow, print the flags that would reproduce it: \"next time: ",[62,1189,1103],{},"\". Users learn the fast path from the slow one.",[41,1192,1193,1196],{},[14,1194,1195],{},"Keep TUI and commands in sync by construction",", not by discipline: the same core functions, and tests that exercise both.",[41,1198,1199,1202,1203,1206,1207,31],{},[14,1200,1201],{},"Respect the environment."," Prompts and TUIs must detect when they cannot run — pipes, CI, ",[62,1204,1205],{},"TERM=dumb"," — and fall back or fail fast, as in ",[27,1208,1210],{"href":1209},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells\u002F","detecting CI environments and non-interactive shells",[33,1212,1214],{"id":1213},"testing-the-behaviour","Testing the behaviour",[10,1216,1217,1218,1221],{},"Test every layer's non-interactive contract with ",[62,1219,1220],{},"CliRunner"," — which provides no terminal, so it exercises exactly the paths scripts and CI take:",[147,1223,1225],{"className":149,"code":1224,"language":151,"meta":152,"style":152},"# tests\u002Ftest_layers.py\nfrom typer.testing import CliRunner\n\nfrom mytool.cli import app\n\nrunner = CliRunner()\n\n\ndef test_flags_only_never_prompts(tmp_path, monkeypatch):\n    monkeypatch.chdir(tmp_path)\n    result = runner.invoke(app, [\"init\", \"--name\", \"web\", \"--template\", \"service\"])\n    assert result.exit_code == 0\n    assert (tmp_path \u002F \"web\" \u002F \"TEMPLATE\").read_text() == \"service\\n\"\n\n\ndef test_missing_name_without_terminal_fails_fast(tmp_path, monkeypatch):\n    monkeypatch.chdir(tmp_path)\n    result = runner.invoke(app, [\"init\"])\n    assert result.exit_code == 2\n    assert \"--name\" in result.output\n\n\ndef test_default_template_when_not_interactive(tmp_path, monkeypatch):\n    monkeypatch.chdir(tmp_path)\n    assert runner.invoke(app, [\"init\", \"--name\", \"api\"]).exit_code == 0\n    assert (tmp_path \u002F \"api\" \u002F \"TEMPLATE\").read_text() == \"basic\\n\"\n\n\ndef test_picker_refuses_without_terminal():\n    result = runner.invoke(app, [\"pick\"])\n    assert result.exit_code == 2 and \"mytool list\" in result.output\n",[62,1226,1227,1232,1244,1248,1260,1264,1274,1278,1282,1292,1297,1331,1345,1375,1379,1383,1392,1396,1408,1419,1431,1435,1439,1448,1452,1476,1502,1506,1510,1520,1533],{"__ignoreMap":152},[156,1228,1229],{"class":158,"line":159},[156,1230,1231],{"class":162},"# tests\u002Ftest_layers.py\n",[156,1233,1234,1236,1239,1241],{"class":158,"line":166},[156,1235,170],{"class":169},[156,1237,1238],{"class":180}," typer.testing ",[156,1240,194],{"class":169},[156,1242,1243],{"class":180}," CliRunner\n",[156,1245,1246],{"class":158,"line":184},[156,1247,188],{"emptyLinePlaceholder":187},[156,1249,1250,1252,1255,1257],{"class":158,"line":191},[156,1251,170],{"class":169},[156,1253,1254],{"class":180}," mytool.cli ",[156,1256,194],{"class":169},[156,1258,1259],{"class":180}," app\n",[156,1261,1262],{"class":158,"line":200},[156,1263,188],{"emptyLinePlaceholder":187},[156,1265,1266,1269,1271],{"class":158,"line":213},[156,1267,1268],{"class":180},"runner ",[156,1270,258],{"class":169},[156,1272,1273],{"class":180}," CliRunner()\n",[156,1275,1276],{"class":158,"line":218},[156,1277,188],{"emptyLinePlaceholder":187},[156,1279,1280],{"class":158,"line":226},[156,1281,188],{"emptyLinePlaceholder":187},[156,1283,1284,1286,1289],{"class":158,"line":231},[156,1285,277],{"class":169},[156,1287,1288],{"class":280}," test_flags_only_never_prompts",[156,1290,1291],{"class":180},"(tmp_path, monkeypatch):\n",[156,1293,1294],{"class":158,"line":247},[156,1295,1296],{"class":180},"    monkeypatch.chdir(tmp_path)\n",[156,1298,1299,1302,1304,1307,1310,1312,1314,1316,1319,1321,1324,1326,1328],{"class":158,"line":252},[156,1300,1301],{"class":180},"    result ",[156,1303,258],{"class":169},[156,1305,1306],{"class":180}," runner.invoke(app, [",[156,1308,1309],{"class":345},"\"init\"",[156,1311,17],{"class":180},[156,1313,580],{"class":345},[156,1315,17],{"class":180},[156,1317,1318],{"class":345},"\"web\"",[156,1320,17],{"class":180},[156,1322,1323],{"class":345},"\"--template\"",[156,1325,17],{"class":180},[156,1327,931],{"class":345},[156,1329,1330],{"class":180},"])\n",[156,1332,1333,1336,1339,1342],{"class":158,"line":264},[156,1334,1335],{"class":169},"    assert",[156,1337,1338],{"class":180}," result.exit_code ",[156,1340,1341],{"class":169},"==",[156,1343,1344],{"class":173}," 0\n",[156,1346,1347,1349,1352,1354,1357,1360,1362,1365,1367,1370,1372],{"class":158,"line":269},[156,1348,1335],{"class":169},[156,1350,1351],{"class":180}," (tmp_path ",[156,1353,1053],{"class":169},[156,1355,1356],{"class":345}," \"web\"",[156,1358,1359],{"class":169}," \u002F",[156,1361,1056],{"class":345},[156,1363,1364],{"class":180},").read_text() ",[156,1366,1341],{"class":169},[156,1368,1369],{"class":345}," \"service",[156,1371,1068],{"class":173},[156,1373,1374],{"class":345},"\"\n",[156,1376,1377],{"class":158,"line":274},[156,1378,188],{"emptyLinePlaceholder":187},[156,1380,1381],{"class":158,"line":293},[156,1382,188],{"emptyLinePlaceholder":187},[156,1384,1385,1387,1390],{"class":158,"line":308},[156,1386,277],{"class":169},[156,1388,1389],{"class":280}," test_missing_name_without_terminal_fails_fast",[156,1391,1291],{"class":180},[156,1393,1394],{"class":158,"line":313},[156,1395,1296],{"class":180},[156,1397,1398,1400,1402,1404,1406],{"class":158,"line":318},[156,1399,1301],{"class":180},[156,1401,258],{"class":169},[156,1403,1306],{"class":180},[156,1405,1309],{"class":345},[156,1407,1330],{"class":180},[156,1409,1410,1412,1414,1416],{"class":158,"line":327},[156,1411,1335],{"class":169},[156,1413,1338],{"class":180},[156,1415,1341],{"class":169},[156,1417,1418],{"class":173}," 2\n",[156,1420,1421,1423,1426,1428],{"class":158,"line":342},[156,1422,1335],{"class":169},[156,1424,1425],{"class":345}," \"--name\"",[156,1427,989],{"class":169},[156,1429,1430],{"class":180}," result.output\n",[156,1432,1433],{"class":158,"line":349},[156,1434,188],{"emptyLinePlaceholder":187},[156,1436,1437],{"class":158,"line":354},[156,1438,188],{"emptyLinePlaceholder":187},[156,1440,1441,1443,1446],{"class":158,"line":359},[156,1442,277],{"class":169},[156,1444,1445],{"class":280}," test_default_template_when_not_interactive",[156,1447,1291],{"class":180},[156,1449,1450],{"class":158,"line":367},[156,1451,1296],{"class":180},[156,1453,1454,1456,1458,1460,1462,1464,1466,1469,1472,1474],{"class":158,"line":378},[156,1455,1335],{"class":169},[156,1457,1306],{"class":180},[156,1459,1309],{"class":345},[156,1461,17],{"class":180},[156,1463,580],{"class":345},[156,1465,17],{"class":180},[156,1467,1468],{"class":345},"\"api\"",[156,1470,1471],{"class":180},"]).exit_code ",[156,1473,1341],{"class":169},[156,1475,1344],{"class":173},[156,1477,1478,1480,1482,1484,1487,1489,1491,1493,1495,1498,1500],{"class":158,"line":415},[156,1479,1335],{"class":169},[156,1481,1351],{"class":180},[156,1483,1053],{"class":169},[156,1485,1486],{"class":345}," \"api\"",[156,1488,1359],{"class":169},[156,1490,1056],{"class":345},[156,1492,1364],{"class":180},[156,1494,1341],{"class":169},[156,1496,1497],{"class":345}," \"basic",[156,1499,1068],{"class":173},[156,1501,1374],{"class":345},[156,1503,1504],{"class":158,"line":468},[156,1505,188],{"emptyLinePlaceholder":187},[156,1507,1508],{"class":158,"line":499},[156,1509,188],{"emptyLinePlaceholder":187},[156,1511,1512,1514,1517],{"class":158,"line":509},[156,1513,277],{"class":169},[156,1515,1516],{"class":280}," test_picker_refuses_without_terminal",[156,1518,1519],{"class":180},"():\n",[156,1521,1522,1524,1526,1528,1531],{"class":158,"line":515},[156,1523,1301],{"class":180},[156,1525,258],{"class":169},[156,1527,1306],{"class":180},[156,1529,1530],{"class":345},"\"pick\"",[156,1532,1330],{"class":180},[156,1534,1535,1537,1539,1541,1544,1547,1550,1552],{"class":158,"line":534},[156,1536,1335],{"class":169},[156,1538,1338],{"class":180},[156,1540,1341],{"class":169},[156,1542,1543],{"class":173}," 2",[156,1545,1546],{"class":169}," and",[156,1548,1549],{"class":345}," \"mytool list\"",[156,1551,989],{"class":169},[156,1553,1430],{"class":180},[10,1555,1556,1557,1560,1561,1563,1564,1567],{},"For the interactive paths, patch ",[62,1558,1559],{},"interactive"," to return ",[62,1562,697],{}," and feed answers through ",[62,1565,1566],{},"input="," to test prompts, and use Textual's Pilot for the TUI. The non-interactive tests above matter most: they are what guarantees that adding interactivity never breaks automation.",[33,1569,1571],{"id":1570},"conclusion","Conclusion",[10,1573,1574],{},"Commands, prompt flows and TUIs are tools for different jobs: commands for anything repeated or automated, prompts for rare tasks with several decisions, TUIs for exploring and watching data. Choose by how the task is done, and build them as layers — prompts that only fill gaps left by flags, a TUI that calls the same core and returns data to commands — so every task gets the right interface and none of them becomes a second implementation. Keep the non-interactive paths tested, and interactivity will only ever add to what the tool can do.",[33,1576,1578],{"id":1577},"frequently-asked-questions","Frequently asked questions",[1580,1581,1583,1584,1586,1587,1590],"h3",{"id":1582},"should-init-prompt-by-default-or-require-interactive","Should ",[62,1585,134],{}," prompt by default or require ",[62,1588,1589],{},"--interactive","?",[10,1592,1593,1594,1596,1597,1599],{},"Prompting by default when a terminal is attached and values are missing is the friendliest behaviour, provided it never prompts without a terminal and ",[62,1595,1119],{}," disables it. Requiring ",[62,1598,1589],{}," suits tools whose users are mostly automation.",[1580,1601,1603],{"id":1602},"is-a-wizard-with-many-steps-ever-a-good-idea","Is a \"wizard\" with many steps ever a good idea?",[10,1605,1606],{},"For genuinely complex one-time setup, yes — but keep it short, show progress (\"step 2 of 4\"), allow going back, and write the result to a config file the user can edit instead of re-running the wizard.",[1580,1608,1610],{"id":1609},"when-is-richs-live-display-enough-instead-of-a-tui","When is Rich's Live display enough instead of a TUI?",[10,1612,1613,1614,1618],{},"When the user only watches and does not navigate. A Live table or progress display, as in ",[27,1615,1617],{"href":1616},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live\u002F","live dashboards with Rich Live",", is far simpler than a TUI and stays inside a normal command.",[1580,1620,1622],{"id":1621},"can-the-tui-call-the-clis-commands-directly","Can the TUI call the CLI's commands directly?",[10,1624,1625],{},"Call the core functions instead. Invoking Click commands from inside a TUI mixes two input models and makes errors awkward to show. The TUI and commands should be siblings over the same core, not layered on each other.",[33,1627,1629],{"id":1628},"related","Related",[38,1631,1632,1638,1644,1649,1654],{},[41,1633,1634,1635],{},"Up: ",[27,1636,1637],{"href":29},"Building terminal UIs with Textual",[41,1639,1640],{},[27,1641,1643],{"href":1642},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbuilding-your-first-textual-app\u002F","Building your first Textual app",[41,1645,1646],{},[27,1647,1648],{"href":1140},"Testing Textual apps with Pilot",[41,1650,1651],{},[27,1652,1653],{"href":1157},"Building interactive prompts and menus",[41,1655,1656],{},[27,1657,1659],{"href":1658},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002F","Designing CLI interfaces and conventions",[1661,1662,1663],"style",{},"html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}html pre.shiki code .szBVR, html code.shiki .szBVR{--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html pre.shiki code .s4XuR, html code.shiki .s4XuR{--shiki-default:#E36209;--shiki-dark:#FFAB70}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":152,"searchDepth":166,"depth":166,"links":1665},[1666,1667,1668,1669,1670,1671,1672,1673,1674,1681],{"id":35,"depth":166,"text":36},{"id":53,"depth":166,"text":54},{"id":80,"depth":166,"text":81},{"id":138,"depth":166,"text":139},{"id":1162,"depth":166,"text":1163},{"id":1172,"depth":166,"text":1173},{"id":1213,"depth":166,"text":1214},{"id":1570,"depth":166,"text":1571},{"id":1577,"depth":166,"text":1578,"children":1675},[1676,1678,1679,1680],{"id":1582,"depth":184,"text":1677},"Should init prompt by default or require --interactive?",{"id":1602,"depth":184,"text":1603},{"id":1609,"depth":184,"text":1610},{"id":1621,"depth":184,"text":1622},{"id":1628,"depth":166,"text":1629},"2026-09-18","Decide how a Python tool should interact with people: plain commands, guided prompts or a full-screen TUI — with criteria, a layered design and code for each.","beginner",false,"md",{},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fchoosing-between-a-cli-a-prompt-flow-and-a-tui",{"title":5,"description":1683},"advanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fchoosing-between-a-cli-a-prompt-flow-and-a-tui\u002Findex",[1692,1693,1694,1695],"cli-design","tui","prompts","ux","eU_nxyQCUd1hCDQDIPukaI0M7TS3oHQ16gsYt7E9ENE",[1698,1701,1704,1707,1710,1713,1716,1719,1722,1725,1728,1729,1732,1735,1738,1741,1744,1747,1750,1753,1756,1759,1762,1765,1768,1771,1774,1777,1780,1783,1786,1789,1792,1795,1798,1801,1804,1807,1810,1813,1816,1819,1822,1825,1828,1831,1834,1837,1840,1843,1846,1849,1852,1855,1858,1861,1864,1867,1870,1873,1876,1879,1882,1885,1888,1891,1894,1897,1900,1903,1906,1909,1912,1915,1918,1921,1924,1927,1930,1933,1936,1939,1942,1945,1948,1951,1954,1957,1960,1963,1966,1969,1972,1975,1978,1981,1984,1987,1990,1993,1996,1999,2002,2005,2008,2011,2014,2017,2020,2023,2026,2029,2032,2035,2038,2041,2044,2047,2050,2053,2056,2059,2062,2065,2068,2071,2074,2077,2080,2083,2086,2089,2092,2095,2098,2101,2104,2107,2110,2113,2115,2118,2121,2124,2127,2130,2133,2136,2139,2142,2145,2148,2151,2154,2157,2160,2163,2166,2169,2172,2175,2178,2181,2184,2187,2190,2193,2196,2199,2202,2205,2208,2211,2214,2217,2220,2223,2226,2229,2232,2235,2238,2241,2244,2247,2250,2253,2256,2259,2262,2265,2268,2271,2274,2277,2280,2283,2286,2289,2292,2295,2298,2301,2304,2307,2310,2313,2316,2319,2322,2325,2328,2331,2334,2337,2340,2343,2346,2349,2352,2355,2358,2361,2364,2367,2370,2373,2376,2379,2382,2385,2388,2391,2394,2397,2400,2403,2406,2409,2412,2415,2418,2421,2424,2427,2430,2433,2436,2439,2442,2445,2448,2451,2454,2457,2460,2463,2466,2469,2472,2475,2478,2481,2484,2487,2490,2493,2496,2499,2502,2505,2508,2511,2514,2517,2520,2523,2526,2529,2532,2535,2538],{"path":1699,"title":1700},"\u002Fabout","About Python CLI Toolcraft",{"path":1702,"title":1703},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":1705,"title":1706},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":1708,"title":1709},"\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":1711,"title":1712},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":1714,"title":1715},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":1717,"title":1718},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-urls-hosts-and-ports","Validating URLs, Hosts and Ports in Python CLI Arguments",{"path":1720,"title":1721},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":1723,"title":1724},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbrowsing-records-with-a-textual-datatable","Browsing Records with a Textual DataTable Picker",{"path":1726,"title":1727},"\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":1688,"title":5},{"path":1730,"title":1731},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":1733,"title":1734},"\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":1736,"title":1737},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fstyling-textual-apps-with-tcss","Styling Textual Apps with TCSS",{"path":1739,"title":1740},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":1742,"title":1743},"\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":1745,"title":1746},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fdocumenting-environment-variables-in-help","Documenting Environment Variables in CLI Help",{"path":1748,"title":1749},"\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":1751,"title":1752},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":1754,"title":1755},"\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":1757,"title":1758},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":1760,"title":1761},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":1763,"title":1764},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":1766,"title":1767},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":1769,"title":1770},"\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":1772,"title":1773},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fhandling-ansi-escape-codes-on-windows-consoles","Handling ANSI Escape Codes on Windows Consoles",{"path":1775,"title":1776},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":1778,"title":1779},"\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":1781,"title":1782},"\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":1784,"title":1785},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":1787,"title":1788},"\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":1790,"title":1791},"\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":1793,"title":1794},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":1796,"title":1797},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":1799,"title":1800},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":1802,"title":1803},"\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":1805,"title":1806},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fwriting-crash-reports-users-can-send","Writing Crash Reports Users Can Send",{"path":1808,"title":1809},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":1811,"title":1812},"\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":1814,"title":1815},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":1817,"title":1818},"\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":1820,"title":1821},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":1823,"title":1824},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":1826,"title":1827},"\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":1829,"title":1830},"\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":1832,"title":1833},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":1835,"title":1836},"\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":1838,"title":1839},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":1841,"title":1842},"\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":1844,"title":1845},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":1847,"title":1848},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":1850,"title":1851},"\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":1853,"title":1854},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":1856,"title":1857},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":1859,"title":1860},"\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":1862,"title":1863},"\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":1865,"title":1866},"\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":1868,"title":1869},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis","Output Formats for Data-Heavy Python CLIs",{"path":1871,"title":1872},"\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":1874,"title":1875},"\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":1877,"title":1878},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fargcomplete-for-argparse-clis","Tab Completion for argparse CLIs with argcomplete",{"path":1880,"title":1881},"\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":1883,"title":1884},"\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":1886,"title":1887},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":1889,"title":1890},"\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":1892,"title":1893},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages","Shipping Shell Completion Scripts with a Python CLI",{"path":1895,"title":1896},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":1898,"title":1899},"\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":1901,"title":1902},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":1904,"title":1905},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":1907,"title":1908},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Flogging-with-structlog-in-a-cli","Logging with structlog in a Python CLI",{"path":1910,"title":1911},"\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":1913,"title":1914},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":1916,"title":1917},"\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":1919,"title":1920},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":1922,"title":1923},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":1925,"title":1926},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":1928,"title":1929},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":1931,"title":1932},"\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":1934,"title":1935},"\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":1937,"title":1938},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":1940,"title":1941},"\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":1943,"title":1944},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":1946,"title":1947},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":1949,"title":1950},"\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":1952,"title":1953},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":1955,"title":1956},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":1958,"title":1959},"\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":1961,"title":1962},"\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":1964,"title":1965},"\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":1967,"title":1968},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":1970,"title":1971},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":1973,"title":1974},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":1976,"title":1977},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":1979,"title":1980},"\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":1982,"title":1983},"\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":1985,"title":1986},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fstructured-concurrency-with-taskgroups-in-clis","Structured Concurrency with TaskGroups in Python CLIs",{"path":1988,"title":1989},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":1991,"title":1992},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":1994,"title":1995},"\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":1997,"title":1998},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":2000,"title":2001},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":2003,"title":2004},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":2006,"title":2007},"\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":2009,"title":2010},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":2012,"title":2013},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":2015,"title":2016},"\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":2018,"title":2019},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis","Local State and SQLite in Python CLIs",{"path":2021,"title":2022},"\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":2024,"title":2025},"\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":2027,"title":2028},"\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":2030,"title":2031},"\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":2033,"title":2034},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":2036,"title":2037},"\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":2039,"title":2040},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":2042,"title":2043},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Freloading-config-on-sighup","Reloading Configuration on SIGHUP in a Python CLI",{"path":2045,"title":2046},"\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":2048,"title":2049},"\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":2051,"title":2052},"\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":2054,"title":2055},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":2057,"title":2058},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":2060,"title":2061},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":2063,"title":2064},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":2066,"title":2067},"\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":2069,"title":2070},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fpiping-between-subprocesses-in-python","Piping Between Subprocesses in Python Without a Shell",{"path":2072,"title":2073},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":2075,"title":2076},"\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":2078,"title":2079},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":2081,"title":2082},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":2084,"title":2085},"\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":2087,"title":2088},"\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":2090,"title":2091},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Frefreshing-expired-tokens-automatically","Refreshing Expired Tokens Automatically in a Python CLI",{"path":2093,"title":2094},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":2096,"title":2097},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":2099,"title":2100},"\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":2102,"title":2103},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis","Update Checks, Upgrade Commands and Telemetry for Python CLIs",{"path":2105,"title":2106},"\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":2108,"title":2109},"\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":2111,"title":2112},"\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":1053,"title":2114},"Python CLI Toolcraft",{"path":2116,"title":2117},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo","Building a Python CLI with Cleo Command Classes",{"path":2119,"title":2120},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts","Building a Type-Hinted Python CLI with Cyclopts",{"path":2122,"title":2123},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks","Beyond Click and Typer: Alternative Python CLI Frameworks",{"path":2125,"title":2126},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fquick-clis-from-functions-with-python-fire","Quick CLIs from Functions with Python Fire",{"path":2128,"title":2129},"\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":2131,"title":2132},"\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":2134,"title":2135},"\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":2137,"title":2138},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fguarding-startup-with-import-tests","Guarding CLI Startup with Import Tests",{"path":2140,"title":2141},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":2143,"title":2144},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":2146,"title":2147},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":2149,"title":2150},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":2152,"title":2153},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":2155,"title":2156},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":2158,"title":2159},"\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":2161,"title":2162},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":2164,"title":2165},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":2167,"title":2168},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":2170,"title":2171},"\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":2173,"title":2174},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":2176,"title":2177},"\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":2179,"title":2180},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fdesigning-idempotent-commands","Designing Idempotent Commands in a Python CLI",{"path":2182,"title":2183},"\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":2185,"title":2186},"\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":2188,"title":2189},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":2191,"title":2192},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":2194,"title":2195},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fpositional-arguments-vs-options","Positional Arguments vs Options: Designing a CLI Signature",{"path":2197,"title":2198},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":2200,"title":2201},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":2203,"title":2204},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":2206,"title":2207},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":2209,"title":2210},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures","Isolating Plugin Failures in an Extensible Python CLI",{"path":2212,"title":2213},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli","Testing Plugins Against the Host CLI",{"path":2215,"title":2216},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":2218,"title":2219},"\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":2221,"title":2222},"\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":2224,"title":2225},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":2227,"title":2228},"\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":2230,"title":2231},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":2233,"title":2234},"\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":2236,"title":2237},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically","Registering CLI Commands from Modules Automatically",{"path":2239,"title":2240},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":2242,"title":2243},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":2245,"title":2246},"\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":2248,"title":2249},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":2251,"title":2252},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":2254,"title":2255},"\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":2257,"title":2258},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":2260,"title":2261},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":2263,"title":2264},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":2266,"title":2267},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-commands-that-call-subprocesses","Testing Python CLI Commands That Call Subprocesses",{"path":2269,"title":2270},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":2272,"title":2273},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands","Transcript Tests for Python CLI Commands",{"path":2275,"title":2276},"\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":2278,"title":2279},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":2281,"title":2282},"\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":2284,"title":2285},"\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":2287,"title":2288},"\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":2290,"title":2291},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":2293,"title":2294},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Frich-markup-and-help-panels-in-typer","Rich Markup and Help Panels in Typer",{"path":2296,"title":2297},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":2299,"title":2300},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":2302,"title":2303},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":2305,"title":2306},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":2308,"title":2309},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":2311,"title":2312},"\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":2314,"title":2315},"\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":2317,"title":2318},"\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":2320,"title":2321},"\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":2323,"title":2324},"\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":2326,"title":2327},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":2329,"title":2330},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":2332,"title":2333},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":2335,"title":2336},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":2338,"title":2339},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftemplate-variables-and-conditional-files","Template Variables and Conditional Files in CLI Templates",{"path":2341,"title":2342},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftesting-a-project-template-with-pytest","Testing a CLI Project Template with pytest",{"path":2344,"title":2345},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fupdating-generated-projects-with-copier-update","Updating Generated CLI Projects with copier update",{"path":2347,"title":2348},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":2350,"title":2351},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":2353,"title":2354},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fcode-signing-and-notarizing-cli-binaries","Code Signing and Notarizing Python CLI Binaries",{"path":2356,"title":2357},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":2359,"title":2360},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":2362,"title":2363},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":2365,"title":2366},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Freducing-pyinstaller-binary-size","Reducing the Size of a PyInstaller CLI Binary",{"path":2368,"title":2369},"\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":2371,"title":2372},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":2374,"title":2375},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":2377,"title":2378},"\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":2380,"title":2381},"\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":2383,"title":2384},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":2386,"title":2387},"\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":2389,"title":2390},"\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":2392,"title":2393},"\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":2395,"title":2396},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":2398,"title":2399},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fbumping-versions-consistently-across-a-cli-project","Bumping Versions Consistently Across a Python CLI Project",{"path":2401,"title":2402},"\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":2404,"title":2405},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":2407,"title":2408},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":2410,"title":2411},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":2413,"title":2414},"\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":2416,"title":2417},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":2419,"title":2420},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":2422,"title":2423},"\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":2425,"title":2426},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":2428,"title":2429},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":2431,"title":2432},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Foptional-dependencies-and-extras-for-clis","Optional Dependencies and Extras for Python CLIs",{"path":2434,"title":2435},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":2437,"title":2438},"\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":2440,"title":2441},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fdynamic-versioning-with-poetry-plugins","Dynamic Versioning for a Poetry CLI from Git Tags",{"path":2443,"title":2444},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":2446,"title":2447},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmanaging-poetry-lock-files-for-cli-tools","Managing Poetry Lock Files for CLI Tools",{"path":2449,"title":2450},"\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":2452,"title":2453},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":2455,"title":2456},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":2458,"title":2459},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpublishing-a-cli-with-poetry","Building and Publishing a Python CLI with Poetry",{"path":2461,"title":2462},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":2464,"title":2465},"\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":2467,"title":2468},"\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":2470,"title":2471},"\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":2473,"title":2474},"\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":2476,"title":2477},"\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":2479,"title":2480},"\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":2482,"title":2483},"\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":2485,"title":2486},"\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":2488,"title":2489},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain","Securing the Supply Chain of a Python CLI",{"path":2491,"title":2492},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpinning-dependencies-with-hashes","Pinning a Python CLI’s Dependencies with Hashes",{"path":2494,"title":2495},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpublishing-attestations-and-verifying-releases","Publishing Attestations and Verifying Python CLI Releases",{"path":2497,"title":2498},"\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":2500,"title":2501},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":2503,"title":2504},"\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":2506,"title":2507},"\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":2509,"title":2510},"\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":2512,"title":2513},"\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":2515,"title":2516},"\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":2518,"title":2519},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":2521,"title":2522},"\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":2524,"title":2525},"\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":2527,"title":2528},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":2530,"title":2531},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fisolating-cli-tools-from-project-dependencies","Isolating CLI Tools from Your Project’s Dependencies",{"path":2533,"title":2534},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":2536,"title":2537},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":2539,"title":2540},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1790967537197]