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