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