[{"data":1,"prerenderedAt":2594},["ShallowReactive",2],{"page-\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Ffollowing-posix-and-gnu-argument-conventions\u002F":3,"content-directory":2047},{"id":4,"title":5,"body":6,"date":2031,"description":2032,"difficulty":2033,"draft":2034,"extension":2035,"meta":2036,"navigation":185,"path":2037,"seo":2038,"stem":2039,"tags":2040,"updated":2031,"__hash__":2046},"content\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Ffollowing-posix-and-gnu-argument-conventions\u002Findex.md","Following POSIX and GNU Argument Conventions in Python",{"type":7,"value":8,"toc":2008},"minimark",[9,48,53,63,67,71,126,132,136,145,886,889,997,1017,1024,1027,1042,1046,1049,1185,1213,1217,1220,1235,1239,1323,1327,1330,1831,1849,1853,1875,1879,1883,1894,1898,1924,1928,1939,1946,1960,1967,1970,1974,2004],[10,11,12,13,17,18,21,22,25,26,29,30,33,34,37,38,41,42,47],"p",{},"Command-line users carry decades of expectations into every new tool. ",[14,15,16],"code",{},"-h"," shows help. ",[14,19,20],{},"-v -v"," or ",[14,23,24],{},"-vv"," means more verbose. ",[14,27,28],{},"--output=file.txt"," and ",[14,31,32],{},"--output file.txt"," mean the same thing. ",[14,35,36],{},"--"," stops option parsing so a filename starting with a dash is treated as a filename. ",[14,39,40],{},"-"," means standard input. A usage error exits with status 2. None of this is enforced by the operating system; it is convention — partly written down in the POSIX utility syntax guidelines, extended by the GNU coding standards, and reinforced by every tool people use daily. A CLI that follows these conventions feels immediately familiar; one that breaks them feels foreign and is harder to script. This guide lists the conventions that matter, shows which ones Click, Typer and argparse give you for free, and implements the ones they leave to you. It belongs to the ",[43,44,46],"a",{"href":45},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002F","designing CLI interfaces and conventions topic",".",[49,50,52],"h2",{"id":51},"prerequisites","Prerequisites",[54,55,56,60],"ul",{},[57,58,59],"li",{},"A CLI built with Click, Typer or argparse.",[57,61,62],{},"An interest in making it behave well in pipelines and scripts, not only interactively.",[49,64,66],{"id":65},"the-conventions-and-who-implements-them","The conventions, and who implements them",[68,69],"inline-diagram",{"name":70},"px-conventions",[10,72,73,77,78,81,82,85,86,89,90,93,94,97,98,97,101,97,104,107,108,111,112,115,116,120,121,125],{},[74,75,76],"strong",{},"Short options"," are a single dash and a single letter (",[14,79,80],{},"-v","), and several without arguments can be combined (",[14,83,84],{},"-xvf file","). ",[74,87,88],{},"Long options"," (a GNU extension, now universal) are two dashes and a word (",[14,91,92],{},"--verbose","). An option's value can follow as the next word or be attached: ",[14,95,96],{},"-o out.txt",", ",[14,99,100],{},"-oout.txt",[14,102,103],{},"--output out.txt",[14,105,106],{},"--output=out.txt",". ",[74,109,110],{},"Options and positional arguments may be interleaved"," (",[14,113,114],{},"ls dir -l","), another GNU extension that POSIX itself does not require. ",[74,117,118],{},[14,119,36],{}," ends option processing: everything after it is positional, even if it starts with a dash. And ",[74,122,123],{},[14,124,40],{}," as a filename means standard input (or output), by long convention.",[10,127,128,129,131],{},"Click and argparse implement all of these except the last: ",[14,130,40],{}," is just a string until your code gives it meaning. Typer, which is built on Click, behaves the same way.",[49,133,135],{"id":134},"the-recipe-the-parts-you-implement","The recipe: the parts you implement",[10,137,138,139,141,142,144],{},"Here is a small Typer command that follows the conventions end to end — combined short flags, ",[14,140,16],{},", reading ",[14,143,40],{}," as stdin, writing results to stdout and everything else to stderr, and exit status 2 for usage errors:",[146,147,152],"pre",{"className":148,"code":149,"language":150,"meta":151,"style":151},"language-python shiki shiki-themes github-light github-dark","# src\u002Fmytool\u002Fcli.py\nfrom typing import Annotated\n\nimport click\nimport typer\n\napp = typer.Typer(context_settings={\"help_option_names\": [\"-h\", \"--help\"]})\n\n\n@app.command()\ndef count(\n    files: Annotated[list[typer.FileText], typer.Argument(help=\"Files to read; '-' for stdin.\")] = None,\n    lines: Annotated[bool, typer.Option(\"--lines\", \"-l\", help=\"Count lines.\")] = False,\n    words: Annotated[bool, typer.Option(\"--words\", \"-w\", help=\"Count words.\")] = False,\n    verbose: Annotated[int, typer.Option(\"--verbose\", \"-v\", count=True)] = 0,\n) -> None:\n    \"\"\"Count lines and words, like a small wc.\"\"\"\n    if not (lines or words):\n        lines = words = True\n    sources = files or [click.open_file(\"-\")]        # no files: read stdin, like wc\n    total_l = total_w = 0\n    for fh in sources:\n        text = fh.read()\n        n_l, n_w = text.count(\"\\n\"), len(text.split())\n        total_l, total_w = total_l + n_l, total_w + n_w\n        name = \"-\" if fh.name == \"\u003Cstdin>\" else fh.name\n        cols = ([f\"{n_l:>7}\"] if lines else []) + ([f\"{n_w:>7}\"] if words else [])\n        typer.echo(\" \".join(cols + [name]))            # results -> stdout\n        if verbose:\n            typer.echo(f\"read {name}\", err=True)        # narration -> stderr\n    if len(sources) > 1:\n        cols = ([f\"{total_l:>7}\"] if lines else []) + ([f\"{total_w:>7}\"] if words else [])\n        typer.echo(\" \".join(cols + [\"total\"]))\n\n\nif __name__ == \"__main__\":\n    app()\n","python","",[14,153,154,163,180,187,195,203,208,247,252,257,267,279,305,343,378,416,428,434,452,468,493,509,524,535,563,585,614,688,708,717,752,771,834,854,859,864,880],{"__ignoreMap":151},[155,156,159],"span",{"class":157,"line":158},"line",1,[155,160,162],{"class":161},"sJ8bj","# src\u002Fmytool\u002Fcli.py\n",[155,164,166,170,174,177],{"class":157,"line":165},2,[155,167,169],{"class":168},"szBVR","from",[155,171,173],{"class":172},"sVt8B"," typing ",[155,175,176],{"class":168},"import",[155,178,179],{"class":172}," Annotated\n",[155,181,183],{"class":157,"line":182},3,[155,184,186],{"emptyLinePlaceholder":185},true,"\n",[155,188,190,192],{"class":157,"line":189},4,[155,191,176],{"class":168},[155,193,194],{"class":172}," click\n",[155,196,198,200],{"class":157,"line":197},5,[155,199,176],{"class":168},[155,201,202],{"class":172}," typer\n",[155,204,206],{"class":157,"line":205},6,[155,207,186],{"emptyLinePlaceholder":185},[155,209,211,214,217,220,224,226,229,233,236,239,241,244],{"class":157,"line":210},7,[155,212,213],{"class":172},"app ",[155,215,216],{"class":168},"=",[155,218,219],{"class":172}," typer.Typer(",[155,221,223],{"class":222},"s4XuR","context_settings",[155,225,216],{"class":168},[155,227,228],{"class":172},"{",[155,230,232],{"class":231},"sZZnC","\"help_option_names\"",[155,234,235],{"class":172},": [",[155,237,238],{"class":231},"\"-h\"",[155,240,97],{"class":172},[155,242,243],{"class":231},"\"--help\"",[155,245,246],{"class":172},"]})\n",[155,248,250],{"class":157,"line":249},8,[155,251,186],{"emptyLinePlaceholder":185},[155,253,255],{"class":157,"line":254},9,[155,256,186],{"emptyLinePlaceholder":185},[155,258,260,264],{"class":157,"line":259},10,[155,261,263],{"class":262},"sScJk","@app.command",[155,265,266],{"class":172},"()\n",[155,268,270,273,276],{"class":157,"line":269},11,[155,271,272],{"class":168},"def",[155,274,275],{"class":262}," count",[155,277,278],{"class":172},"(\n",[155,280,282,285,288,290,293,296,298,302],{"class":157,"line":281},12,[155,283,284],{"class":172},"    files: Annotated[list[typer.FileText], typer.Argument(",[155,286,287],{"class":222},"help",[155,289,216],{"class":168},[155,291,292],{"class":231},"\"Files to read; '-' for stdin.\"",[155,294,295],{"class":172},")] ",[155,297,216],{"class":168},[155,299,301],{"class":300},"sj4cs"," None",[155,303,304],{"class":172},",\n",[155,306,308,311,314,317,320,322,325,327,329,331,334,336,338,341],{"class":157,"line":307},13,[155,309,310],{"class":172},"    lines: Annotated[",[155,312,313],{"class":300},"bool",[155,315,316],{"class":172},", typer.Option(",[155,318,319],{"class":231},"\"--lines\"",[155,321,97],{"class":172},[155,323,324],{"class":231},"\"-l\"",[155,326,97],{"class":172},[155,328,287],{"class":222},[155,330,216],{"class":168},[155,332,333],{"class":231},"\"Count lines.\"",[155,335,295],{"class":172},[155,337,216],{"class":168},[155,339,340],{"class":300}," False",[155,342,304],{"class":172},[155,344,346,349,351,353,356,358,361,363,365,367,370,372,374,376],{"class":157,"line":345},14,[155,347,348],{"class":172},"    words: Annotated[",[155,350,313],{"class":300},[155,352,316],{"class":172},[155,354,355],{"class":231},"\"--words\"",[155,357,97],{"class":172},[155,359,360],{"class":231},"\"-w\"",[155,362,97],{"class":172},[155,364,287],{"class":222},[155,366,216],{"class":168},[155,368,369],{"class":231},"\"Count words.\"",[155,371,295],{"class":172},[155,373,216],{"class":168},[155,375,340],{"class":300},[155,377,304],{"class":172},[155,379,381,384,387,389,392,394,397,399,402,404,407,409,411,414],{"class":157,"line":380},15,[155,382,383],{"class":172},"    verbose: Annotated[",[155,385,386],{"class":300},"int",[155,388,316],{"class":172},[155,390,391],{"class":231},"\"--verbose\"",[155,393,97],{"class":172},[155,395,396],{"class":231},"\"-v\"",[155,398,97],{"class":172},[155,400,401],{"class":222},"count",[155,403,216],{"class":168},[155,405,406],{"class":300},"True",[155,408,295],{"class":172},[155,410,216],{"class":168},[155,412,413],{"class":300}," 0",[155,415,304],{"class":172},[155,417,419,422,425],{"class":157,"line":418},16,[155,420,421],{"class":172},") -> ",[155,423,424],{"class":300},"None",[155,426,427],{"class":172},":\n",[155,429,431],{"class":157,"line":430},17,[155,432,433],{"class":231},"    \"\"\"Count lines and words, like a small wc.\"\"\"\n",[155,435,437,440,443,446,449],{"class":157,"line":436},18,[155,438,439],{"class":168},"    if",[155,441,442],{"class":168}," not",[155,444,445],{"class":172}," (lines ",[155,447,448],{"class":168},"or",[155,450,451],{"class":172}," words):\n",[155,453,455,458,460,463,465],{"class":157,"line":454},19,[155,456,457],{"class":172},"        lines ",[155,459,216],{"class":168},[155,461,462],{"class":172}," words ",[155,464,216],{"class":168},[155,466,467],{"class":300}," True\n",[155,469,471,474,476,479,481,484,487,490],{"class":157,"line":470},20,[155,472,473],{"class":172},"    sources ",[155,475,216],{"class":168},[155,477,478],{"class":172}," files ",[155,480,448],{"class":168},[155,482,483],{"class":172}," [click.open_file(",[155,485,486],{"class":231},"\"-\"",[155,488,489],{"class":172},")]        ",[155,491,492],{"class":161},"# no files: read stdin, like wc\n",[155,494,496,499,501,504,506],{"class":157,"line":495},21,[155,497,498],{"class":172},"    total_l ",[155,500,216],{"class":168},[155,502,503],{"class":172}," total_w ",[155,505,216],{"class":168},[155,507,508],{"class":300}," 0\n",[155,510,512,515,518,521],{"class":157,"line":511},22,[155,513,514],{"class":168},"    for",[155,516,517],{"class":172}," fh ",[155,519,520],{"class":168},"in",[155,522,523],{"class":172}," sources:\n",[155,525,527,530,532],{"class":157,"line":526},23,[155,528,529],{"class":172},"        text ",[155,531,216],{"class":168},[155,533,534],{"class":172}," fh.read()\n",[155,536,538,541,543,546,549,552,554,557,560],{"class":157,"line":537},24,[155,539,540],{"class":172},"        n_l, n_w ",[155,542,216],{"class":168},[155,544,545],{"class":172}," text.count(",[155,547,548],{"class":231},"\"",[155,550,551],{"class":300},"\\n",[155,553,548],{"class":231},[155,555,556],{"class":172},"), ",[155,558,559],{"class":300},"len",[155,561,562],{"class":172},"(text.split())\n",[155,564,566,569,571,574,577,580,582],{"class":157,"line":565},25,[155,567,568],{"class":172},"        total_l, total_w ",[155,570,216],{"class":168},[155,572,573],{"class":172}," total_l ",[155,575,576],{"class":168},"+",[155,578,579],{"class":172}," n_l, total_w ",[155,581,576],{"class":168},[155,583,584],{"class":172}," n_w\n",[155,586,588,591,593,596,599,602,605,608,611],{"class":157,"line":587},26,[155,589,590],{"class":172},"        name ",[155,592,216],{"class":168},[155,594,595],{"class":231}," \"-\"",[155,597,598],{"class":168}," if",[155,600,601],{"class":172}," fh.name ",[155,603,604],{"class":168},"==",[155,606,607],{"class":231}," \"\u003Cstdin>\"",[155,609,610],{"class":168}," else",[155,612,613],{"class":172}," fh.name\n",[155,615,617,620,622,625,628,630,632,635,638,641,643,646,649,652,655,658,660,662,664,666,668,671,673,675,677,679,681,683,685],{"class":157,"line":616},27,[155,618,619],{"class":172},"        cols ",[155,621,216],{"class":168},[155,623,624],{"class":172}," ([",[155,626,627],{"class":168},"f",[155,629,548],{"class":231},[155,631,228],{"class":300},[155,633,634],{"class":172},"n_l",[155,636,637],{"class":168},":>7",[155,639,640],{"class":300},"}",[155,642,548],{"class":231},[155,644,645],{"class":172},"] ",[155,647,648],{"class":168},"if",[155,650,651],{"class":172}," lines ",[155,653,654],{"class":168},"else",[155,656,657],{"class":172}," []) ",[155,659,576],{"class":168},[155,661,624],{"class":172},[155,663,627],{"class":168},[155,665,548],{"class":231},[155,667,228],{"class":300},[155,669,670],{"class":172},"n_w",[155,672,637],{"class":168},[155,674,640],{"class":300},[155,676,548],{"class":231},[155,678,645],{"class":172},[155,680,648],{"class":168},[155,682,462],{"class":172},[155,684,654],{"class":168},[155,686,687],{"class":172}," [])\n",[155,689,691,694,697,700,702,705],{"class":157,"line":690},28,[155,692,693],{"class":172},"        typer.echo(",[155,695,696],{"class":231},"\" \"",[155,698,699],{"class":172},".join(cols ",[155,701,576],{"class":168},[155,703,704],{"class":172}," [name]))            ",[155,706,707],{"class":161},"# results -> stdout\n",[155,709,711,714],{"class":157,"line":710},29,[155,712,713],{"class":168},"        if",[155,715,716],{"class":172}," verbose:\n",[155,718,720,723,725,728,730,733,735,737,739,742,744,746,749],{"class":157,"line":719},30,[155,721,722],{"class":172},"            typer.echo(",[155,724,627],{"class":168},[155,726,727],{"class":231},"\"read ",[155,729,228],{"class":300},[155,731,732],{"class":172},"name",[155,734,640],{"class":300},[155,736,548],{"class":231},[155,738,97],{"class":172},[155,740,741],{"class":222},"err",[155,743,216],{"class":168},[155,745,406],{"class":300},[155,747,748],{"class":172},")        ",[155,750,751],{"class":161},"# narration -> stderr\n",[155,753,755,757,760,763,766,769],{"class":157,"line":754},31,[155,756,439],{"class":168},[155,758,759],{"class":300}," len",[155,761,762],{"class":172},"(sources) ",[155,764,765],{"class":168},">",[155,767,768],{"class":300}," 1",[155,770,427],{"class":172},[155,772,774,776,778,780,782,784,786,789,791,793,795,797,799,801,803,805,807,809,811,813,815,818,820,822,824,826,828,830,832],{"class":157,"line":773},32,[155,775,619],{"class":172},[155,777,216],{"class":168},[155,779,624],{"class":172},[155,781,627],{"class":168},[155,783,548],{"class":231},[155,785,228],{"class":300},[155,787,788],{"class":172},"total_l",[155,790,637],{"class":168},[155,792,640],{"class":300},[155,794,548],{"class":231},[155,796,645],{"class":172},[155,798,648],{"class":168},[155,800,651],{"class":172},[155,802,654],{"class":168},[155,804,657],{"class":172},[155,806,576],{"class":168},[155,808,624],{"class":172},[155,810,627],{"class":168},[155,812,548],{"class":231},[155,814,228],{"class":300},[155,816,817],{"class":172},"total_w",[155,819,637],{"class":168},[155,821,640],{"class":300},[155,823,548],{"class":231},[155,825,645],{"class":172},[155,827,648],{"class":168},[155,829,462],{"class":172},[155,831,654],{"class":168},[155,833,687],{"class":172},[155,835,837,839,841,843,845,848,851],{"class":157,"line":836},33,[155,838,693],{"class":172},[155,840,696],{"class":231},[155,842,699],{"class":172},[155,844,576],{"class":168},[155,846,847],{"class":172}," [",[155,849,850],{"class":231},"\"total\"",[155,852,853],{"class":172},"]))\n",[155,855,857],{"class":157,"line":856},34,[155,858,186],{"emptyLinePlaceholder":185},[155,860,862],{"class":157,"line":861},35,[155,863,186],{"emptyLinePlaceholder":185},[155,865,867,869,872,875,878],{"class":157,"line":866},36,[155,868,648],{"class":168},[155,870,871],{"class":300}," __name__",[155,873,874],{"class":168}," ==",[155,876,877],{"class":231}," \"__main__\"",[155,879,427],{"class":172},[155,881,883],{"class":157,"line":882},37,[155,884,885],{"class":172},"    app()\n",[10,887,888],{},"What this gives users, with only one explicit line of convention handling:",[146,890,894],{"className":891,"code":892,"language":893,"meta":151,"style":151},"language-bash shiki shiki-themes github-light github-dark","mytool -lw notes.txt todo.txt          # combined short flags\nmytool --lines=true ...                # rejected: boolean flags take no value, as users expect\ncat notes.txt | mytool -l              # no files: read stdin\nmytool -l - \u003C notes.txt                # '-' is stdin, via typer.FileText \u002F click.File\nmytool -l -- -draft.md                 # '--' ends options; '-draft.md' is a file\nmytool -h                              # short help, because help_option_names includes -h\nmytool --bogus                         # usage error, exit status 2\n","bash",[14,895,896,913,926,945,962,977,987],{"__ignoreMap":151},[155,897,898,901,904,907,910],{"class":157,"line":158},[155,899,900],{"class":262},"mytool",[155,902,903],{"class":300}," -lw",[155,905,906],{"class":231}," notes.txt",[155,908,909],{"class":231}," todo.txt",[155,911,912],{"class":161},"          # combined short flags\n",[155,914,915,917,920,923],{"class":157,"line":165},[155,916,900],{"class":262},[155,918,919],{"class":300}," --lines=true",[155,921,922],{"class":231}," ...",[155,924,925],{"class":161},"                # rejected: boolean flags take no value, as users expect\n",[155,927,928,931,933,936,939,942],{"class":157,"line":182},[155,929,930],{"class":262},"cat",[155,932,906],{"class":231},[155,934,935],{"class":168}," |",[155,937,938],{"class":262}," mytool",[155,940,941],{"class":300}," -l",[155,943,944],{"class":161},"              # no files: read stdin\n",[155,946,947,949,951,954,957,959],{"class":157,"line":189},[155,948,900],{"class":262},[155,950,941],{"class":300},[155,952,953],{"class":231}," -",[155,955,956],{"class":168}," \u003C",[155,958,906],{"class":231},[155,960,961],{"class":161},"                # '-' is stdin, via typer.FileText \u002F click.File\n",[155,963,964,966,968,971,974],{"class":157,"line":197},[155,965,900],{"class":262},[155,967,941],{"class":300},[155,969,970],{"class":300}," --",[155,972,973],{"class":300}," -draft.md",[155,975,976],{"class":161},"                 # '--' ends options; '-draft.md' is a file\n",[155,978,979,981,984],{"class":157,"line":205},[155,980,900],{"class":262},[155,982,983],{"class":300}," -h",[155,985,986],{"class":161},"                              # short help, because help_option_names includes -h\n",[155,988,989,991,994],{"class":157,"line":210},[155,990,900],{"class":262},[155,992,993],{"class":300}," --bogus",[155,995,996],{"class":161},"                         # usage error, exit status 2\n",[10,998,999,1002,1003,1006,1007,1009,1010,1012,1013,47],{},[14,1000,1001],{},"typer.FileText"," (Click's ",[14,1004,1005],{},"click.File",") is what makes ",[14,1008,40],{}," work: Click opens the special name ",[14,1011,40],{}," as stdin for read mode and stdout for write mode, and opens real paths lazily with proper error messages. Reading piped input more generally is covered in ",[43,1014,1016],{"href":1015},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis\u002F","reading piped input in Python CLIs",[1018,1019,1021,1023],"h3",{"id":1020},"matters-most-in-scripts",[14,1022,36],{}," matters most in scripts",[68,1025],{"name":1026},"px-dashdash-terminal",[10,1028,1029,1030,1032,1033,1037,1038,47],{},"Filenames can begin with a dash, and scripts that pass arbitrary filenames to your tool must be able to say \"these are files, not options\". Click and argparse support ",[14,1031,36],{}," automatically; your documentation should mention it, and any code of yours that builds command lines for ",[1034,1035,1036],"em",{},"other"," programs should use it too — the same protection described in ",[43,1039,1041],{"href":1040},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis\u002F","avoiding shell injection in Python CLIs",[1018,1043,1045],{"id":1044},"argparse-settings-worth-changing","argparse settings worth changing",[10,1047,1048],{},"argparse follows the conventions too, with two defaults worth revisiting:",[146,1050,1052],{"className":148,"code":1051,"language":150,"meta":151,"style":151},"import argparse\n\nparser = argparse.ArgumentParser(\n    prog=\"mytool\",\n    allow_abbrev=False,          # --verb must not silently mean --verbose\n)\nparser.add_argument(\"-v\", \"--verbose\", action=\"count\", default=0)\nparser.add_argument(\"files\", nargs=\"*\", type=argparse.FileType(\"r\"), default=[\"-\"])\n",[14,1053,1054,1061,1065,1075,1087,1103,1108,1141],{"__ignoreMap":151},[155,1055,1056,1058],{"class":157,"line":158},[155,1057,176],{"class":168},[155,1059,1060],{"class":172}," argparse\n",[155,1062,1063],{"class":157,"line":165},[155,1064,186],{"emptyLinePlaceholder":185},[155,1066,1067,1070,1072],{"class":157,"line":182},[155,1068,1069],{"class":172},"parser ",[155,1071,216],{"class":168},[155,1073,1074],{"class":172}," argparse.ArgumentParser(\n",[155,1076,1077,1080,1082,1085],{"class":157,"line":189},[155,1078,1079],{"class":222},"    prog",[155,1081,216],{"class":168},[155,1083,1084],{"class":231},"\"mytool\"",[155,1086,304],{"class":172},[155,1088,1089,1092,1094,1097,1100],{"class":157,"line":197},[155,1090,1091],{"class":222},"    allow_abbrev",[155,1093,216],{"class":168},[155,1095,1096],{"class":300},"False",[155,1098,1099],{"class":172},",          ",[155,1101,1102],{"class":161},"# --verb must not silently mean --verbose\n",[155,1104,1105],{"class":157,"line":205},[155,1106,1107],{"class":172},")\n",[155,1109,1110,1113,1115,1117,1119,1121,1124,1126,1129,1131,1134,1136,1139],{"class":157,"line":210},[155,1111,1112],{"class":172},"parser.add_argument(",[155,1114,396],{"class":231},[155,1116,97],{"class":172},[155,1118,391],{"class":231},[155,1120,97],{"class":172},[155,1122,1123],{"class":222},"action",[155,1125,216],{"class":168},[155,1127,1128],{"class":231},"\"count\"",[155,1130,97],{"class":172},[155,1132,1133],{"class":222},"default",[155,1135,216],{"class":168},[155,1137,1138],{"class":300},"0",[155,1140,1107],{"class":172},[155,1142,1143,1145,1148,1150,1153,1155,1158,1160,1163,1165,1168,1171,1173,1175,1177,1180,1182],{"class":157,"line":249},[155,1144,1112],{"class":172},[155,1146,1147],{"class":231},"\"files\"",[155,1149,97],{"class":172},[155,1151,1152],{"class":222},"nargs",[155,1154,216],{"class":168},[155,1156,1157],{"class":231},"\"*\"",[155,1159,97],{"class":172},[155,1161,1162],{"class":222},"type",[155,1164,216],{"class":168},[155,1166,1167],{"class":172},"argparse.FileType(",[155,1169,1170],{"class":231},"\"r\"",[155,1172,556],{"class":172},[155,1174,1133],{"class":222},[155,1176,216],{"class":168},[155,1178,1179],{"class":172},"[",[155,1181,486],{"class":231},[155,1183,1184],{"class":172},"])\n",[10,1186,1187,1190,1191,1194,1195,1198,1199,1202,1203,1205,1206,1208,1209,47],{},[14,1188,1189],{},"allow_abbrev=True"," (the default) accepts any unambiguous prefix of a long option. It is convenient until you add ",[14,1192,1193],{},"--verify",", at which point every script using ",[14,1196,1197],{},"--ver"," breaks. ",[14,1200,1201],{},"argparse.FileType(\"r\")"," gives the same ",[14,1204,40],{}," handling as ",[14,1207,1005],{},". More argparse specifics are in ",[43,1210,1212],{"href":1211},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002F","the argparse topic",[49,1214,1216],{"id":1215},"exit-statuses-are-conventions-too","Exit statuses are conventions too",[68,1218],{"name":1219},"px-exit-matrix",[10,1221,1222,1223,1226,1227,1230,1231,47],{},"0 means success, any non-zero value means failure, and several values have established meanings: 1 for a general failure, 2 for incorrect usage (which Click and argparse already use for parse errors), 126 and 127 for \"cannot execute\" and \"not found\" from shells, 124 from ",[14,1224,1225],{},"timeout(1)",", 128 plus the signal number for processes killed by a signal, and the ",[14,1228,1229],{},"sysexits.h"," range 64–78 for specific conditions. Scripts depend on these; the full treatment is in ",[43,1232,1234],{"href":1233},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools\u002F","choosing exit codes for CLI tools",[49,1236,1238],{"id":1237},"ux-considerations","UX considerations",[54,1240,1241,1251,1277,1285,1307],{},[57,1242,1243,1246,1247,47],{},[74,1244,1245],{},"stdout for results, stderr for everything else."," The single most important stream convention: progress, warnings, prompts and diagnostics go to stderr so pipelines carry only data. See ",[43,1248,1250],{"href":1249},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002F","working with stdin, stdout and pipes",[57,1252,1253,1256,1257,1260,1261,1264,1265,1268,1269,1272,1273,1276],{},[74,1254,1255],{},"Respect environment conventions."," ",[14,1258,1259],{},"NO_COLOR"," disables colour, ",[14,1262,1263],{},"TERM=dumb"," implies no fancy output, ",[14,1266,1267],{},"PAGER"," chooses the pager, ",[14,1270,1271],{},"EDITOR"," the editor, ",[14,1274,1275],{},"TMPDIR"," the temporary directory. Rich and Click already honour several of these.",[57,1278,1279,1282,1283,47],{},[74,1280,1281],{},"Silence is golden."," Unix tools say nothing on success unless they produce data. A tool that prints \"Done!\" after every command is noisy in scripts; reserve such messages for ",[14,1284,80],{},[57,1286,1287,1292,1293,1296,1297,1299,1300,1303,1304,1306],{},[74,1288,1289,1290,47],{},"Accept ",[14,1291,16],{}," Click's default is only ",[14,1294,1295],{},"--help","; adding ",[14,1298,16],{}," through ",[14,1301,1302],{},"help_option_names"," matches what users try first — unless ",[14,1305,16],{}," means something else in your domain (such as \"host\"), in which case do not overload it.",[57,1308,1309,1312,1313,97,1316,21,1319,1322],{},[74,1310,1311],{},"Do not invent syntax."," Custom forms like ",[14,1314,1315],{},"+option",[14,1317,1318],{},"\u002Foption",[14,1320,1321],{},"option:value"," are learnable but unexpected; prefer the standard forms even when a custom one would be shorter.",[49,1324,1326],{"id":1325},"testing-the-behaviour","Testing the behaviour",[10,1328,1329],{},"Conventions are exactly the kind of behaviour that regresses quietly, so pin them with tests:",[146,1331,1333],{"className":148,"code":1332,"language":150,"meta":151,"style":151},"# tests\u002Ftest_conventions.py\nfrom typer.testing import CliRunner\n\nfrom mytool.cli import app\n\nrunner = CliRunner()\n\n\ndef test_combined_short_flags(tmp_path):\n    f = tmp_path \u002F \"a.txt\"\n    f.write_text(\"one two\\nthree\\n\")\n    result = runner.invoke(app, [\"-lw\", str(f)])\n    assert result.exit_code == 0\n    assert result.stdout.split()[:2] == [\"2\", \"3\"]\n\n\ndef test_dash_reads_stdin():\n    result = runner.invoke(app, [\"-l\", \"-\"], input=\"a\\nb\\nc\\n\")\n    assert result.stdout.split()[0] == \"3\"\n\n\ndef test_no_files_reads_stdin():\n    result = runner.invoke(app, [\"-w\"], input=\"x y z\\n\")\n    assert result.stdout.split()[0] == \"3\"\n\n\ndef test_double_dash_allows_dash_filenames(tmp_path, monkeypatch):\n    monkeypatch.chdir(tmp_path)\n    (tmp_path \u002F \"-draft.md\").write_text(\"hi\\n\")\n    assert runner.invoke(app, [\"-l\", \"--\", \"-draft.md\"]).exit_code == 0\n\n\ndef test_short_help_and_usage_errors():\n    assert runner.invoke(app, [\"-h\"]).exit_code == 0\n    assert runner.invoke(app, [\"--bogus\"]).exit_code == 2\n\n\ndef test_narration_goes_to_stderr(tmp_path):\n    f = tmp_path \u002F \"a.txt\"\n    f.write_text(\"x\\n\")\n    result = runner.invoke(app, [\"-v\", str(f)])\n    assert \"read\" not in result.stdout and \"read\" in result.stderr\n",[14,1334,1335,1340,1352,1356,1368,1372,1382,1386,1390,1400,1416,1435,1456,1468,1495,1499,1503,1513,1554,1570,1574,1578,1587,1612,1626,1630,1634,1644,1649,1671,1696,1700,1704,1713,1727,1743,1747,1751,1761,1774,1788,1805],{"__ignoreMap":151},[155,1336,1337],{"class":157,"line":158},[155,1338,1339],{"class":161},"# tests\u002Ftest_conventions.py\n",[155,1341,1342,1344,1347,1349],{"class":157,"line":165},[155,1343,169],{"class":168},[155,1345,1346],{"class":172}," typer.testing ",[155,1348,176],{"class":168},[155,1350,1351],{"class":172}," CliRunner\n",[155,1353,1354],{"class":157,"line":182},[155,1355,186],{"emptyLinePlaceholder":185},[155,1357,1358,1360,1363,1365],{"class":157,"line":189},[155,1359,169],{"class":168},[155,1361,1362],{"class":172}," mytool.cli ",[155,1364,176],{"class":168},[155,1366,1367],{"class":172}," app\n",[155,1369,1370],{"class":157,"line":197},[155,1371,186],{"emptyLinePlaceholder":185},[155,1373,1374,1377,1379],{"class":157,"line":205},[155,1375,1376],{"class":172},"runner ",[155,1378,216],{"class":168},[155,1380,1381],{"class":172}," CliRunner()\n",[155,1383,1384],{"class":157,"line":210},[155,1385,186],{"emptyLinePlaceholder":185},[155,1387,1388],{"class":157,"line":249},[155,1389,186],{"emptyLinePlaceholder":185},[155,1391,1392,1394,1397],{"class":157,"line":254},[155,1393,272],{"class":168},[155,1395,1396],{"class":262}," test_combined_short_flags",[155,1398,1399],{"class":172},"(tmp_path):\n",[155,1401,1402,1405,1407,1410,1413],{"class":157,"line":259},[155,1403,1404],{"class":172},"    f ",[155,1406,216],{"class":168},[155,1408,1409],{"class":172}," tmp_path ",[155,1411,1412],{"class":168},"\u002F",[155,1414,1415],{"class":231}," \"a.txt\"\n",[155,1417,1418,1421,1424,1426,1429,1431,1433],{"class":157,"line":269},[155,1419,1420],{"class":172},"    f.write_text(",[155,1422,1423],{"class":231},"\"one two",[155,1425,551],{"class":300},[155,1427,1428],{"class":231},"three",[155,1430,551],{"class":300},[155,1432,548],{"class":231},[155,1434,1107],{"class":172},[155,1436,1437,1440,1442,1445,1448,1450,1453],{"class":157,"line":281},[155,1438,1439],{"class":172},"    result ",[155,1441,216],{"class":168},[155,1443,1444],{"class":172}," runner.invoke(app, [",[155,1446,1447],{"class":231},"\"-lw\"",[155,1449,97],{"class":172},[155,1451,1452],{"class":300},"str",[155,1454,1455],{"class":172},"(f)])\n",[155,1457,1458,1461,1464,1466],{"class":157,"line":307},[155,1459,1460],{"class":168},"    assert",[155,1462,1463],{"class":172}," result.exit_code ",[155,1465,604],{"class":168},[155,1467,508],{"class":300},[155,1469,1470,1472,1475,1478,1480,1482,1484,1487,1489,1492],{"class":157,"line":345},[155,1471,1460],{"class":168},[155,1473,1474],{"class":172}," result.stdout.split()[:",[155,1476,1477],{"class":300},"2",[155,1479,645],{"class":172},[155,1481,604],{"class":168},[155,1483,847],{"class":172},[155,1485,1486],{"class":231},"\"2\"",[155,1488,97],{"class":172},[155,1490,1491],{"class":231},"\"3\"",[155,1493,1494],{"class":172},"]\n",[155,1496,1497],{"class":157,"line":380},[155,1498,186],{"emptyLinePlaceholder":185},[155,1500,1501],{"class":157,"line":418},[155,1502,186],{"emptyLinePlaceholder":185},[155,1504,1505,1507,1510],{"class":157,"line":430},[155,1506,272],{"class":168},[155,1508,1509],{"class":262}," test_dash_reads_stdin",[155,1511,1512],{"class":172},"():\n",[155,1514,1515,1517,1519,1521,1523,1525,1527,1530,1533,1535,1538,1540,1543,1545,1548,1550,1552],{"class":157,"line":436},[155,1516,1439],{"class":172},[155,1518,216],{"class":168},[155,1520,1444],{"class":172},[155,1522,324],{"class":231},[155,1524,97],{"class":172},[155,1526,486],{"class":231},[155,1528,1529],{"class":172},"], ",[155,1531,1532],{"class":222},"input",[155,1534,216],{"class":168},[155,1536,1537],{"class":231},"\"a",[155,1539,551],{"class":300},[155,1541,1542],{"class":231},"b",[155,1544,551],{"class":300},[155,1546,1547],{"class":231},"c",[155,1549,551],{"class":300},[155,1551,548],{"class":231},[155,1553,1107],{"class":172},[155,1555,1556,1558,1561,1563,1565,1567],{"class":157,"line":454},[155,1557,1460],{"class":168},[155,1559,1560],{"class":172}," result.stdout.split()[",[155,1562,1138],{"class":300},[155,1564,645],{"class":172},[155,1566,604],{"class":168},[155,1568,1569],{"class":231}," \"3\"\n",[155,1571,1572],{"class":157,"line":470},[155,1573,186],{"emptyLinePlaceholder":185},[155,1575,1576],{"class":157,"line":495},[155,1577,186],{"emptyLinePlaceholder":185},[155,1579,1580,1582,1585],{"class":157,"line":511},[155,1581,272],{"class":168},[155,1583,1584],{"class":262}," test_no_files_reads_stdin",[155,1586,1512],{"class":172},[155,1588,1589,1591,1593,1595,1597,1599,1601,1603,1606,1608,1610],{"class":157,"line":526},[155,1590,1439],{"class":172},[155,1592,216],{"class":168},[155,1594,1444],{"class":172},[155,1596,360],{"class":231},[155,1598,1529],{"class":172},[155,1600,1532],{"class":222},[155,1602,216],{"class":168},[155,1604,1605],{"class":231},"\"x y z",[155,1607,551],{"class":300},[155,1609,548],{"class":231},[155,1611,1107],{"class":172},[155,1613,1614,1616,1618,1620,1622,1624],{"class":157,"line":537},[155,1615,1460],{"class":168},[155,1617,1560],{"class":172},[155,1619,1138],{"class":300},[155,1621,645],{"class":172},[155,1623,604],{"class":168},[155,1625,1569],{"class":231},[155,1627,1628],{"class":157,"line":565},[155,1629,186],{"emptyLinePlaceholder":185},[155,1631,1632],{"class":157,"line":587},[155,1633,186],{"emptyLinePlaceholder":185},[155,1635,1636,1638,1641],{"class":157,"line":616},[155,1637,272],{"class":168},[155,1639,1640],{"class":262}," test_double_dash_allows_dash_filenames",[155,1642,1643],{"class":172},"(tmp_path, monkeypatch):\n",[155,1645,1646],{"class":157,"line":690},[155,1647,1648],{"class":172},"    monkeypatch.chdir(tmp_path)\n",[155,1650,1651,1654,1656,1659,1662,1665,1667,1669],{"class":157,"line":710},[155,1652,1653],{"class":172},"    (tmp_path ",[155,1655,1412],{"class":168},[155,1657,1658],{"class":231}," \"-draft.md\"",[155,1660,1661],{"class":172},").write_text(",[155,1663,1664],{"class":231},"\"hi",[155,1666,551],{"class":300},[155,1668,548],{"class":231},[155,1670,1107],{"class":172},[155,1672,1673,1675,1677,1679,1681,1684,1686,1689,1692,1694],{"class":157,"line":719},[155,1674,1460],{"class":168},[155,1676,1444],{"class":172},[155,1678,324],{"class":231},[155,1680,97],{"class":172},[155,1682,1683],{"class":231},"\"--\"",[155,1685,97],{"class":172},[155,1687,1688],{"class":231},"\"-draft.md\"",[155,1690,1691],{"class":172},"]).exit_code ",[155,1693,604],{"class":168},[155,1695,508],{"class":300},[155,1697,1698],{"class":157,"line":754},[155,1699,186],{"emptyLinePlaceholder":185},[155,1701,1702],{"class":157,"line":773},[155,1703,186],{"emptyLinePlaceholder":185},[155,1705,1706,1708,1711],{"class":157,"line":836},[155,1707,272],{"class":168},[155,1709,1710],{"class":262}," test_short_help_and_usage_errors",[155,1712,1512],{"class":172},[155,1714,1715,1717,1719,1721,1723,1725],{"class":157,"line":856},[155,1716,1460],{"class":168},[155,1718,1444],{"class":172},[155,1720,238],{"class":231},[155,1722,1691],{"class":172},[155,1724,604],{"class":168},[155,1726,508],{"class":300},[155,1728,1729,1731,1733,1736,1738,1740],{"class":157,"line":861},[155,1730,1460],{"class":168},[155,1732,1444],{"class":172},[155,1734,1735],{"class":231},"\"--bogus\"",[155,1737,1691],{"class":172},[155,1739,604],{"class":168},[155,1741,1742],{"class":300}," 2\n",[155,1744,1745],{"class":157,"line":866},[155,1746,186],{"emptyLinePlaceholder":185},[155,1748,1749],{"class":157,"line":882},[155,1750,186],{"emptyLinePlaceholder":185},[155,1752,1754,1756,1759],{"class":157,"line":1753},38,[155,1755,272],{"class":168},[155,1757,1758],{"class":262}," test_narration_goes_to_stderr",[155,1760,1399],{"class":172},[155,1762,1764,1766,1768,1770,1772],{"class":157,"line":1763},39,[155,1765,1404],{"class":172},[155,1767,216],{"class":168},[155,1769,1409],{"class":172},[155,1771,1412],{"class":168},[155,1773,1415],{"class":231},[155,1775,1777,1779,1782,1784,1786],{"class":157,"line":1776},40,[155,1778,1420],{"class":172},[155,1780,1781],{"class":231},"\"x",[155,1783,551],{"class":300},[155,1785,548],{"class":231},[155,1787,1107],{"class":172},[155,1789,1791,1793,1795,1797,1799,1801,1803],{"class":157,"line":1790},41,[155,1792,1439],{"class":172},[155,1794,216],{"class":168},[155,1796,1444],{"class":172},[155,1798,396],{"class":231},[155,1800,97],{"class":172},[155,1802,1452],{"class":300},[155,1804,1455],{"class":172},[155,1806,1808,1810,1813,1815,1818,1821,1824,1826,1828],{"class":157,"line":1807},42,[155,1809,1460],{"class":168},[155,1811,1812],{"class":231}," \"read\"",[155,1814,442],{"class":168},[155,1816,1817],{"class":168}," in",[155,1819,1820],{"class":172}," result.stdout ",[155,1822,1823],{"class":168},"and",[155,1825,1812],{"class":231},[155,1827,1817],{"class":168},[155,1829,1830],{"class":172}," result.stderr\n",[10,1832,1833,1834,1837,1838,97,1841,1844,1845,47],{},"The last test relies on Click 8.2+ ",[14,1835,1836],{},"CliRunner",", which captures stdout and stderr separately (",[14,1839,1840],{},"result.stdout",[14,1842,1843],{},"result.stderr","). It is the test that keeps diagnostics out of pipelines. For whole-output comparisons, see ",[43,1846,1848],{"href":1847},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output\u002F","snapshot testing CLI output",[49,1850,1852],{"id":1851},"conclusion","Conclusion",[10,1854,1855,1856,1859,1860,1862,1863,1865,1866,21,1868,1871,1872,1874],{},"POSIX and GNU conventions are the shared grammar of the command line, and following them is mostly free: Click, Typer and argparse already handle short and long options, combined flags, ",[14,1857,1858],{},"--opt=value",", interleaving and ",[14,1861,36],{},". Your part is giving ",[14,1864,40],{}," its meaning with ",[14,1867,1005],{},[14,1869,1870],{},"argparse.FileType",", adding ",[14,1873,16],{}," where appropriate, disabling argparse's abbreviations, keeping stdout for results and stderr for everything else, honouring the usual environment variables and using conventional exit statuses. Pin them with tests, and your tool will behave the way users' fingers already expect.",[49,1876,1878],{"id":1877},"frequently-asked-questions","Frequently asked questions",[1018,1880,1882],{"id":1881},"should-options-be-allowed-after-positional-arguments","Should options be allowed after positional arguments?",[10,1884,1885,1886,1889,1890,1893],{},"Yes — GNU behaviour, which Click and argparse follow, and what users expect (",[14,1887,1888],{},"mytool file.txt -v","). POSIX strictly stops option processing at the first positional argument; set ",[14,1891,1892],{},"POSIXLY_CORRECT","-style behaviour only if you have a specific need, such as a command that passes its trailing arguments to another program.",[1018,1895,1897],{"id":1896},"how-do-i-pass-trailing-arguments-through-to-another-program","How do I pass trailing arguments through to another program?",[10,1899,1900,1901,1904,1905,1908,1909,1912,1913,1916,1917,29,1920,1923],{},"Use ",[14,1902,1903],{},"context_settings={\"allow_interspersed_args\": False, \"ignore_unknown_options\": True}"," on that command and an argument with ",[14,1906,1907],{},"nargs=-1",", so ",[14,1910,1911],{},"mytool run -- pytest -x -q"," hands ",[14,1914,1915],{},"pytest -x -q"," through untouched. ",[14,1918,1919],{},"uv run",[14,1921,1922],{},"poetry run"," work this way.",[1018,1925,1927],{"id":1926},"should-an-option-be-allowed-more-than-once","Should an option be allowed more than once?",[10,1929,1930,1931,1934,1935,1938],{},"Only when repetition has an obvious meaning. Counting flags (",[14,1932,1933],{},"-vvv",") and accumulating options (",[14,1936,1937],{},"--tag a --tag b",") are conventional; for everything else, the last occurrence should win, which is what Click and argparse do by default. That rule is what lets a script set a default early in a command line and a caller override it by appending the same option later, a pattern shell wrappers rely on.",[1018,1940,1942,1943,1945],{"id":1941},"is-v-for-version-acceptable","Is ",[14,1944,80],{}," for version acceptable?",[10,1947,1948,1949,1951,1952,1955,1956,1959],{},"It conflicts with the far more common ",[14,1950,80],{}," for verbose. Use ",[14,1953,1954],{},"--version"," (and ",[14,1957,1958],{},"-V"," if you want a short form, as Python itself does).",[1018,1961,1963,1964,1966],{"id":1962},"what-about-windows-style-option-syntax","What about Windows-style ",[14,1965,1318],{}," syntax?",[10,1968,1969],{},"Python CLI frameworks do not support it, and modern Windows tools (git, docker, winget) use dash syntax. Stick with dashes everywhere; Windows users are already used to them.",[49,1971,1973],{"id":1972},"related","Related",[54,1975,1976,1982,1988,1994,1999],{},[57,1977,1978,1979],{},"Up: ",[43,1980,1981],{"href":45},"Designing CLI interfaces and conventions",[57,1983,1984],{},[43,1985,1987],{"href":1986},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently\u002F","Naming commands and flags consistently",[57,1989,1990],{},[43,1991,1993],{"href":1992},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fglobal-options-vs-per-command-options\u002F","Global options vs per-command options",[57,1995,1996],{},[43,1997,1998],{"href":1015},"Reading piped input in Python CLIs",[57,2000,2001],{},[43,2002,2003],{"href":1233},"Choosing exit codes for CLI tools",[2005,2006,2007],"style",{},"html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}html pre.shiki code .szBVR, html code.shiki .szBVR{--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .s4XuR, html code.shiki .s4XuR{--shiki-default:#E36209;--shiki-dark:#FFAB70}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":151,"searchDepth":165,"depth":165,"links":2009},[2010,2011,2012,2017,2018,2019,2020,2021,2030],{"id":51,"depth":165,"text":52},{"id":65,"depth":165,"text":66},{"id":134,"depth":165,"text":135,"children":2013},[2014,2016],{"id":1020,"depth":182,"text":2015},"-- matters most in scripts",{"id":1044,"depth":182,"text":1045},{"id":1215,"depth":165,"text":1216},{"id":1237,"depth":165,"text":1238},{"id":1325,"depth":165,"text":1326},{"id":1851,"depth":165,"text":1852},{"id":1877,"depth":165,"text":1878,"children":2022},[2023,2024,2025,2026,2028],{"id":1881,"depth":182,"text":1882},{"id":1896,"depth":182,"text":1897},{"id":1926,"depth":182,"text":1927},{"id":1941,"depth":182,"text":2027},"Is -v for version acceptable?",{"id":1962,"depth":182,"text":2029},"What about Windows-style \u002Foption syntax?",{"id":1972,"depth":165,"text":1973},"2026-09-18","Make a Python CLI behave the way command-line users expect: short and long options, --opt=value, --, the - convention, -h, exit status 2 and stream rules.","intermediate",false,"md",{},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Ffollowing-posix-and-gnu-argument-conventions",{"title":5,"description":2032},"modern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Ffollowing-posix-and-gnu-argument-conventions\u002Findex",[2041,2042,2043,2044,2045],"posix","gnu","cli-design","click","argparse","7f2D4Vx0ERawASXVuFby0AMlTVFCY2cWAAaioQsbNWI",[2048,2051,2054,2057,2060,2063,2066,2069,2072,2075,2078,2081,2084,2087,2090,2093,2096,2099,2102,2105,2108,2111,2114,2117,2120,2123,2126,2129,2132,2135,2138,2141,2144,2147,2150,2153,2156,2159,2162,2165,2168,2171,2174,2177,2180,2183,2186,2189,2192,2195,2198,2201,2204,2207,2210,2213,2216,2219,2222,2225,2228,2231,2234,2237,2240,2243,2246,2249,2252,2255,2258,2261,2264,2267,2270,2273,2276,2279,2282,2285,2288,2291,2294,2297,2300,2303,2306,2309,2312,2315,2318,2321,2323,2326,2329,2332,2335,2338,2341,2344,2347,2350,2353,2356,2359,2360,2363,2366,2369,2372,2375,2378,2381,2384,2387,2390,2393,2396,2399,2402,2405,2408,2411,2414,2417,2420,2423,2426,2429,2432,2435,2438,2441,2444,2447,2450,2453,2456,2459,2462,2465,2468,2471,2474,2477,2480,2483,2486,2489,2492,2495,2498,2501,2504,2507,2510,2513,2516,2519,2522,2525,2528,2531,2534,2537,2540,2543,2546,2549,2552,2555,2558,2561,2564,2567,2570,2573,2576,2579,2582,2585,2588,2591],{"path":2049,"title":2050},"\u002Fabout","About Python CLI Toolcraft",{"path":2052,"title":2053},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":2055,"title":2056},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":2058,"title":2059},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":2061,"title":2062},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":2064,"title":2065},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":2067,"title":2068},"\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":2070,"title":2071},"\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":2073,"title":2074},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":2076,"title":2077},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":2079,"title":2080},"\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":2082,"title":2083},"\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":2085,"title":2086},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":2088,"title":2089},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":2091,"title":2092},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":2094,"title":2095},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":2097,"title":2098},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":2100,"title":2101},"\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":2103,"title":2104},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":2106,"title":2107},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Frespecting-no-color-and-force-color","Respecting NO_COLOR and FORCE_COLOR in Python CLIs",{"path":2109,"title":2110},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":2112,"title":2113},"\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":2115,"title":2116},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":2118,"title":2119},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":2121,"title":2122},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":2124,"title":2125},"\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":2127,"title":2128},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":2130,"title":2131},"\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":2133,"title":2134},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":2136,"title":2137},"\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":2139,"title":2140},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":2142,"title":2143},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":2145,"title":2146},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":2148,"title":2149},"\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":2151,"title":2152},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":2154,"title":2155},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":2157,"title":2158},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":2160,"title":2161},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":2163,"title":2164},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":2166,"title":2167},"\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":2169,"title":2170},"\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":2172,"title":2173},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":2175,"title":2176},"\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":2178,"title":2179},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":2181,"title":2182},"\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":2184,"title":2185},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":2187,"title":2188},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":2190,"title":2191},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":2193,"title":2194},"\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":2196,"title":2197},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":2199,"title":2200},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":2202,"title":2203},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":2205,"title":2206},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":2208,"title":2209},"\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":2211,"title":2212},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":2214,"title":2215},"\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":2217,"title":2218},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":2220,"title":2221},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":2223,"title":2224},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":2226,"title":2227},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":2229,"title":2230},"\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":2232,"title":2233},"\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":2235,"title":2236},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":2238,"title":2239},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":2241,"title":2242},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":2244,"title":2245},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":2247,"title":2248},"\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":2250,"title":2251},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":2253,"title":2254},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":2256,"title":2257},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":2259,"title":2260},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":2262,"title":2263},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":2265,"title":2266},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":2268,"title":2269},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":2271,"title":2272},"\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":2274,"title":2275},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":2277,"title":2278},"\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":2280,"title":2281},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":2283,"title":2284},"\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":2286,"title":2287},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":2289,"title":2290},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":2292,"title":2293},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":2295,"title":2296},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":2298,"title":2299},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":2301,"title":2302},"\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":2304,"title":2305},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":2307,"title":2308},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":2310,"title":2311},"\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":2313,"title":2314},"\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":2316,"title":2317},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":2319,"title":2320},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":1412,"title":2322},"Python CLI Toolcraft",{"path":2324,"title":2325},"\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":2327,"title":2328},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":2330,"title":2331},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":2333,"title":2334},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":2336,"title":2337},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":2339,"title":2340},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":2342,"title":2343},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":2345,"title":2346},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":2348,"title":2349},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":2351,"title":2352},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":2354,"title":2355},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":2357,"title":2358},"\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":2037,"title":5},{"path":2361,"title":2362},"\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":2364,"title":2365},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":2367,"title":2368},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":2370,"title":2371},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":2373,"title":2374},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":2376,"title":2377},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":2379,"title":2380},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":2382,"title":2383},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":2385,"title":2386},"\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":2388,"title":2389},"\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":2391,"title":2392},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":2394,"title":2395},"\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":2397,"title":2398},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":2400,"title":2401},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":2403,"title":2404},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":2406,"title":2407},"\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":2409,"title":2410},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":2412,"title":2413},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":2415,"title":2416},"\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":2418,"title":2419},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":2421,"title":2422},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":2424,"title":2425},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":2427,"title":2428},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":2430,"title":2431},"\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":2433,"title":2434},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":2436,"title":2437},"\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":2439,"title":2440},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":2442,"title":2443},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":2445,"title":2446},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":2448,"title":2449},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":2451,"title":2452},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":2454,"title":2455},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":2457,"title":2458},"\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":2460,"title":2461},"\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":2463,"title":2464},"\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":2466,"title":2467},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":2469,"title":2470},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":2472,"title":2473},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":2475,"title":2476},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":2478,"title":2479},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":2481,"title":2482},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":2484,"title":2485},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":2487,"title":2488},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":2490,"title":2491},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":2493,"title":2494},"\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":2496,"title":2497},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":2499,"title":2500},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":2502,"title":2503},"\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":2505,"title":2506},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":2508,"title":2509},"\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":2511,"title":2512},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":2514,"title":2515},"\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":2517,"title":2518},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":2520,"title":2521},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":2523,"title":2524},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":2526,"title":2527},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":2529,"title":2530},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":2532,"title":2533},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":2535,"title":2536},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":2538,"title":2539},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":2541,"title":2542},"\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":2544,"title":2545},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":2547,"title":2548},"\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":2550,"title":2551},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":2553,"title":2554},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":2556,"title":2557},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":2559,"title":2560},"\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":2562,"title":2563},"\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":2565,"title":2566},"\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":2568,"title":2569},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":2571,"title":2572},"\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":2574,"title":2575},"\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":2577,"title":2578},"\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":2580,"title":2581},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":2583,"title":2584},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":2586,"title":2587},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":2589,"title":2590},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":2592,"title":2593},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1789736907156]