[{"data":1,"prerenderedAt":3161},["ShallowReactive",2],{"page-\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo\u002F":3,"content-directory":2318},{"id":4,"title":5,"body":6,"date":2305,"description":2306,"difficulty":2307,"draft":2308,"extension":2309,"meta":2310,"navigation":153,"path":2311,"seo":2312,"stem":2313,"tags":2314,"updated":2305,"__hash__":2317},"content\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo\u002Findex.md","Building a Python CLI with Cleo Command Classes",{"type":7,"value":8,"toc":2288},"minimark",[9,41,46,72,76,108,112,919,1078,1089,1093,1146,1149,1188,1191,1195,1205,1477,1537,1565,1569,1649,1653,1664,2134,2152,2156,2175,2179,2190,2194,2199,2205,2209,2227,2231,2241,2245,2248,2252,2284],[10,11,12,13,17,18,22,23,26,27,30,31,34,35,40],"p",{},"Most Python CLI frameworks describe commands as decorated functions. Cleo describes them as ",[14,15,16],"strong",{},"classes",": each command declares its name, arguments and options as class attributes and does its work in a ",[19,20,21],"code",{},"handle()"," method, with a rich I\u002FO object for output, questions, tables and progress bars. If you have used Poetry, you have used Cleo — every ",[19,24,25],{},"poetry"," subcommand is a Cleo command. The class-based model suits applications with many commands that share services and conventions, and namespaced names such as ",[19,28,29],{},"db migrate"," and ",[19,32,33],{},"cache clear"," come built in. This guide builds a small application with Cleo 2, covers its console I\u002FO and verbosity levels, notes the behaviours that differ from Click, and tests it with Cleo's testers. It belongs to the ",[36,37,39],"a",{"href":38},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002F","alternative Python CLI frameworks"," topic.",[42,43,45],"h2",{"id":44},"prerequisites","Prerequisites",[47,48,49,61,64],"ul",{},[50,51,52,53,56,57,60],"li",{},"Python 3.10+ and ",[19,54,55],{},"cleo"," (",[19,58,59],{},"uv add cleo","); examples were checked against Cleo 2.1.",[50,62,63],{},"Comfort with classes and inheritance.",[50,65,66,67,71],{},"Optional: the structural ideas in ",[36,68,70],{"href":69},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fhow-to-structure-a-large-python-cli-project\u002F","how to structure a large Python CLI project",", which map well onto command classes.",[42,73,75],{"id":74},"the-shape-of-a-cleo-application","The shape of a Cleo application",[10,77,78,79,82,83,86,87,90,91,90,94,30,97,100,101,103,104,107],{},"An ",[19,80,81],{},"Application"," holds commands. Each ",[19,84,85],{},"Command"," subclass declares ",[19,88,89],{},"name",", ",[19,92,93],{},"description",[19,95,96],{},"arguments",[19,98,99],{},"options","; Cleo builds the parser from those declarations and calls ",[19,102,21],{},", whose integer return value is the exit code. A space in a command name creates a namespace, and the built-in ",[19,105,106],{},"list"," command groups commands by namespace.",[109,110],"inline-diagram",{"name":111},"cleo-structure",[113,114,119],"pre",{"className":115,"code":116,"language":117,"meta":118,"style":118},"language-python shiki shiki-themes github-light github-dark","# src\u002Fgreeter\u002Fcommands.py\nfrom __future__ import annotations\n\nfrom cleo.commands.command import Command\nfrom cleo.helpers import argument, option\n\n\nclass GreetCommand(Command):\n    name = \"greet\"\n    description = \"Greet someone.\"\n    arguments = [argument(\"name\", description=\"Who to greet.\", optional=True)]\n    options = [\n        option(\"yell\", \"y\", description=\"Uppercase the greeting.\", flag=True),\n        option(\"times\", \"t\", description=\"How many times.\", flag=False, default=\"1\"),\n    ]\n\n    def handle(self) -> int:\n        name = self.argument(\"name\") or \"world\"\n        try:\n            times = int(self.option(\"times\"))\n        except ValueError:\n            self.line_error(\"\u003Cerror>--times must be a whole number\u003C\u002Ferror>\")\n            return 2\n        text = f\"Hello {name}\"\n        if self.option(\"yell\"):\n            text = text.upper()\n        for _ in range(times):\n            self.line(f\"\u003Cinfo>{text}\u003C\u002Finfo>\")\n        if self.io.is_verbose():\n            self.line_error(f\"\u003Ccomment>greeted {name} {times}x\u003C\u002Fcomment>\")\n        return 0\n\n\nclass DbMigrateCommand(Command):\n    name = \"db migrate\"\n    description = \"Apply pending database migrations.\"\n    options = [option(\"dry-run\", None, \"Only print the plan.\", flag=True)]\n\n    PENDING = [\"0004_add_index\", \"0005_backfill\", \"0006_drop_legacy\"]\n\n    def handle(self) -> int:\n        self.table([\"Migration\", \"Status\"], [[m, \"pending\"] for m in self.PENDING]).render()\n        if self.option(\"dry-run\"):\n            return 0\n        if not self.confirm(f\"Apply {len(self.PENDING)} migrations?\", False):\n            self.line_error(\"\u003Ccomment>aborted\u003C\u002Fcomment>\")\n            return 1\n        self.line(f\"applied {len(self.PENDING)} migrations\")\n        return 0\n","python","",[19,120,121,130,148,155,169,182,187,192,210,223,234,271,282,317,360,366,371,389,414,422,446,457,472,481,506,520,531,549,575,585,616,625,630,635,649,659,669,702,707,735,740,753,798,811,818,861,873,881,912],{"__ignoreMap":118},[122,123,126],"span",{"class":124,"line":125},"line",1,[122,127,129],{"class":128},"sJ8bj","# src\u002Fgreeter\u002Fcommands.py\n",[122,131,133,137,141,144],{"class":124,"line":132},2,[122,134,136],{"class":135},"szBVR","from",[122,138,140],{"class":139},"sj4cs"," __future__",[122,142,143],{"class":135}," import",[122,145,147],{"class":146},"sVt8B"," annotations\n",[122,149,151],{"class":124,"line":150},3,[122,152,154],{"emptyLinePlaceholder":153},true,"\n",[122,156,158,160,163,166],{"class":124,"line":157},4,[122,159,136],{"class":135},[122,161,162],{"class":146}," cleo.commands.command ",[122,164,165],{"class":135},"import",[122,167,168],{"class":146}," Command\n",[122,170,172,174,177,179],{"class":124,"line":171},5,[122,173,136],{"class":135},[122,175,176],{"class":146}," cleo.helpers ",[122,178,165],{"class":135},[122,180,181],{"class":146}," argument, option\n",[122,183,185],{"class":124,"line":184},6,[122,186,154],{"emptyLinePlaceholder":153},[122,188,190],{"class":124,"line":189},7,[122,191,154],{"emptyLinePlaceholder":153},[122,193,195,198,202,205,207],{"class":124,"line":194},8,[122,196,197],{"class":135},"class",[122,199,201],{"class":200},"sScJk"," GreetCommand",[122,203,204],{"class":146},"(",[122,206,85],{"class":200},[122,208,209],{"class":146},"):\n",[122,211,213,216,219],{"class":124,"line":212},9,[122,214,215],{"class":146},"    name ",[122,217,218],{"class":135},"=",[122,220,222],{"class":221},"sZZnC"," \"greet\"\n",[122,224,226,229,231],{"class":124,"line":225},10,[122,227,228],{"class":146},"    description ",[122,230,218],{"class":135},[122,232,233],{"class":221}," \"Greet someone.\"\n",[122,235,237,240,242,245,248,250,253,255,258,260,263,265,268],{"class":124,"line":236},11,[122,238,239],{"class":146},"    arguments ",[122,241,218],{"class":135},[122,243,244],{"class":146}," [argument(",[122,246,247],{"class":221},"\"name\"",[122,249,90],{"class":146},[122,251,93],{"class":252},"s4XuR",[122,254,218],{"class":135},[122,256,257],{"class":221},"\"Who to greet.\"",[122,259,90],{"class":146},[122,261,262],{"class":252},"optional",[122,264,218],{"class":135},[122,266,267],{"class":139},"True",[122,269,270],{"class":146},")]\n",[122,272,274,277,279],{"class":124,"line":273},12,[122,275,276],{"class":146},"    options ",[122,278,218],{"class":135},[122,280,281],{"class":146}," [\n",[122,283,285,288,291,293,296,298,300,302,305,307,310,312,314],{"class":124,"line":284},13,[122,286,287],{"class":146},"        option(",[122,289,290],{"class":221},"\"yell\"",[122,292,90],{"class":146},[122,294,295],{"class":221},"\"y\"",[122,297,90],{"class":146},[122,299,93],{"class":252},[122,301,218],{"class":135},[122,303,304],{"class":221},"\"Uppercase the greeting.\"",[122,306,90],{"class":146},[122,308,309],{"class":252},"flag",[122,311,218],{"class":135},[122,313,267],{"class":139},[122,315,316],{"class":146},"),\n",[122,318,320,322,325,327,330,332,334,336,339,341,343,345,348,350,353,355,358],{"class":124,"line":319},14,[122,321,287],{"class":146},[122,323,324],{"class":221},"\"times\"",[122,326,90],{"class":146},[122,328,329],{"class":221},"\"t\"",[122,331,90],{"class":146},[122,333,93],{"class":252},[122,335,218],{"class":135},[122,337,338],{"class":221},"\"How many times.\"",[122,340,90],{"class":146},[122,342,309],{"class":252},[122,344,218],{"class":135},[122,346,347],{"class":139},"False",[122,349,90],{"class":146},[122,351,352],{"class":252},"default",[122,354,218],{"class":135},[122,356,357],{"class":221},"\"1\"",[122,359,316],{"class":146},[122,361,363],{"class":124,"line":362},15,[122,364,365],{"class":146},"    ]\n",[122,367,369],{"class":124,"line":368},16,[122,370,154],{"emptyLinePlaceholder":153},[122,372,374,377,380,383,386],{"class":124,"line":373},17,[122,375,376],{"class":135},"    def",[122,378,379],{"class":200}," handle",[122,381,382],{"class":146},"(self) -> ",[122,384,385],{"class":139},"int",[122,387,388],{"class":146},":\n",[122,390,392,395,397,400,403,405,408,411],{"class":124,"line":391},18,[122,393,394],{"class":146},"        name ",[122,396,218],{"class":135},[122,398,399],{"class":139}," self",[122,401,402],{"class":146},".argument(",[122,404,247],{"class":221},[122,406,407],{"class":146},") ",[122,409,410],{"class":135},"or",[122,412,413],{"class":221}," \"world\"\n",[122,415,417,420],{"class":124,"line":416},19,[122,418,419],{"class":135},"        try",[122,421,388],{"class":146},[122,423,425,428,430,433,435,438,441,443],{"class":124,"line":424},20,[122,426,427],{"class":146},"            times ",[122,429,218],{"class":135},[122,431,432],{"class":139}," int",[122,434,204],{"class":146},[122,436,437],{"class":139},"self",[122,439,440],{"class":146},".option(",[122,442,324],{"class":221},[122,444,445],{"class":146},"))\n",[122,447,449,452,455],{"class":124,"line":448},21,[122,450,451],{"class":135},"        except",[122,453,454],{"class":139}," ValueError",[122,456,388],{"class":146},[122,458,460,463,466,469],{"class":124,"line":459},22,[122,461,462],{"class":139},"            self",[122,464,465],{"class":146},".line_error(",[122,467,468],{"class":221},"\"\u003Cerror>--times must be a whole number\u003C\u002Ferror>\"",[122,470,471],{"class":146},")\n",[122,473,475,478],{"class":124,"line":474},23,[122,476,477],{"class":135},"            return",[122,479,480],{"class":139}," 2\n",[122,482,484,487,489,492,495,498,500,503],{"class":124,"line":483},24,[122,485,486],{"class":146},"        text ",[122,488,218],{"class":135},[122,490,491],{"class":135}," f",[122,493,494],{"class":221},"\"Hello ",[122,496,497],{"class":139},"{",[122,499,89],{"class":146},[122,501,502],{"class":139},"}",[122,504,505],{"class":221},"\"\n",[122,507,509,512,514,516,518],{"class":124,"line":508},25,[122,510,511],{"class":135},"        if",[122,513,399],{"class":139},[122,515,440],{"class":146},[122,517,290],{"class":221},[122,519,209],{"class":146},[122,521,523,526,528],{"class":124,"line":522},26,[122,524,525],{"class":146},"            text ",[122,527,218],{"class":135},[122,529,530],{"class":146}," text.upper()\n",[122,532,534,537,540,543,546],{"class":124,"line":533},27,[122,535,536],{"class":135},"        for",[122,538,539],{"class":146}," _ ",[122,541,542],{"class":135},"in",[122,544,545],{"class":139}," range",[122,547,548],{"class":146},"(times):\n",[122,550,552,554,557,560,563,565,568,570,573],{"class":124,"line":551},28,[122,553,462],{"class":139},[122,555,556],{"class":146},".line(",[122,558,559],{"class":135},"f",[122,561,562],{"class":221},"\"\u003Cinfo>",[122,564,497],{"class":139},[122,566,567],{"class":146},"text",[122,569,502],{"class":139},[122,571,572],{"class":221},"\u003C\u002Finfo>\"",[122,574,471],{"class":146},[122,576,578,580,582],{"class":124,"line":577},29,[122,579,511],{"class":135},[122,581,399],{"class":139},[122,583,584],{"class":146},".io.is_verbose():\n",[122,586,588,590,592,594,597,599,601,603,606,609,611,614],{"class":124,"line":587},30,[122,589,462],{"class":139},[122,591,465],{"class":146},[122,593,559],{"class":135},[122,595,596],{"class":221},"\"\u003Ccomment>greeted ",[122,598,497],{"class":139},[122,600,89],{"class":146},[122,602,502],{"class":139},[122,604,605],{"class":139}," {",[122,607,608],{"class":146},"times",[122,610,502],{"class":139},[122,612,613],{"class":221},"x\u003C\u002Fcomment>\"",[122,615,471],{"class":146},[122,617,619,622],{"class":124,"line":618},31,[122,620,621],{"class":135},"        return",[122,623,624],{"class":139}," 0\n",[122,626,628],{"class":124,"line":627},32,[122,629,154],{"emptyLinePlaceholder":153},[122,631,633],{"class":124,"line":632},33,[122,634,154],{"emptyLinePlaceholder":153},[122,636,638,640,643,645,647],{"class":124,"line":637},34,[122,639,197],{"class":135},[122,641,642],{"class":200}," DbMigrateCommand",[122,644,204],{"class":146},[122,646,85],{"class":200},[122,648,209],{"class":146},[122,650,652,654,656],{"class":124,"line":651},35,[122,653,215],{"class":146},[122,655,218],{"class":135},[122,657,658],{"class":221}," \"db migrate\"\n",[122,660,662,664,666],{"class":124,"line":661},36,[122,663,228],{"class":146},[122,665,218],{"class":135},[122,667,668],{"class":221}," \"Apply pending database migrations.\"\n",[122,670,672,674,676,679,682,684,687,689,692,694,696,698,700],{"class":124,"line":671},37,[122,673,276],{"class":146},[122,675,218],{"class":135},[122,677,678],{"class":146}," [option(",[122,680,681],{"class":221},"\"dry-run\"",[122,683,90],{"class":146},[122,685,686],{"class":139},"None",[122,688,90],{"class":146},[122,690,691],{"class":221},"\"Only print the plan.\"",[122,693,90],{"class":146},[122,695,309],{"class":252},[122,697,218],{"class":135},[122,699,267],{"class":139},[122,701,270],{"class":146},[122,703,705],{"class":124,"line":704},38,[122,706,154],{"emptyLinePlaceholder":153},[122,708,710,713,716,719,722,724,727,729,732],{"class":124,"line":709},39,[122,711,712],{"class":139},"    PENDING",[122,714,715],{"class":135}," =",[122,717,718],{"class":146}," [",[122,720,721],{"class":221},"\"0004_add_index\"",[122,723,90],{"class":146},[122,725,726],{"class":221},"\"0005_backfill\"",[122,728,90],{"class":146},[122,730,731],{"class":221},"\"0006_drop_legacy\"",[122,733,734],{"class":146},"]\n",[122,736,738],{"class":124,"line":737},40,[122,739,154],{"emptyLinePlaceholder":153},[122,741,743,745,747,749,751],{"class":124,"line":742},41,[122,744,376],{"class":135},[122,746,379],{"class":200},[122,748,382],{"class":146},[122,750,385],{"class":139},[122,752,388],{"class":146},[122,754,756,759,762,765,767,770,773,776,779,782,785,787,789,792,795],{"class":124,"line":755},42,[122,757,758],{"class":139},"        self",[122,760,761],{"class":146},".table([",[122,763,764],{"class":221},"\"Migration\"",[122,766,90],{"class":146},[122,768,769],{"class":221},"\"Status\"",[122,771,772],{"class":146},"], [[m, ",[122,774,775],{"class":221},"\"pending\"",[122,777,778],{"class":146},"] ",[122,780,781],{"class":135},"for",[122,783,784],{"class":146}," m ",[122,786,542],{"class":135},[122,788,399],{"class":139},[122,790,791],{"class":146},".",[122,793,794],{"class":139},"PENDING",[122,796,797],{"class":146},"]).render()\n",[122,799,801,803,805,807,809],{"class":124,"line":800},43,[122,802,511],{"class":135},[122,804,399],{"class":139},[122,806,440],{"class":146},[122,808,681],{"class":221},[122,810,209],{"class":146},[122,812,814,816],{"class":124,"line":813},44,[122,815,477],{"class":135},[122,817,624],{"class":139},[122,819,821,823,826,828,831,833,836,839,841,843,845,847,850,852,855,857,859],{"class":124,"line":820},45,[122,822,511],{"class":135},[122,824,825],{"class":135}," not",[122,827,399],{"class":139},[122,829,830],{"class":146},".confirm(",[122,832,559],{"class":135},[122,834,835],{"class":221},"\"Apply ",[122,837,838],{"class":139},"{len",[122,840,204],{"class":146},[122,842,437],{"class":139},[122,844,791],{"class":146},[122,846,794],{"class":139},[122,848,849],{"class":146},")",[122,851,502],{"class":139},[122,853,854],{"class":221}," migrations?\"",[122,856,90],{"class":146},[122,858,347],{"class":139},[122,860,209],{"class":146},[122,862,864,866,868,871],{"class":124,"line":863},46,[122,865,462],{"class":139},[122,867,465],{"class":146},[122,869,870],{"class":221},"\"\u003Ccomment>aborted\u003C\u002Fcomment>\"",[122,872,471],{"class":146},[122,874,876,878],{"class":124,"line":875},47,[122,877,477],{"class":135},[122,879,880],{"class":139}," 1\n",[122,882,884,886,888,890,893,895,897,899,901,903,905,907,910],{"class":124,"line":883},48,[122,885,758],{"class":139},[122,887,556],{"class":146},[122,889,559],{"class":135},[122,891,892],{"class":221},"\"applied ",[122,894,838],{"class":139},[122,896,204],{"class":146},[122,898,437],{"class":139},[122,900,791],{"class":146},[122,902,794],{"class":139},[122,904,849],{"class":146},[122,906,502],{"class":139},[122,908,909],{"class":221}," migrations\"",[122,911,471],{"class":146},[122,913,915,917],{"class":124,"line":914},49,[122,916,621],{"class":135},[122,918,624],{"class":139},[113,920,922],{"className":115,"code":921,"language":117,"meta":118,"style":118},"# src\u002Fgreeter\u002Fapp.py\nfrom cleo.application import Application\n\nfrom greeter.commands import DbMigrateCommand, GreetCommand\n\n\ndef create_app() -> Application:\n    app = Application(\"greeter\", \"0.3.0\")\n    app.add(GreetCommand())\n    app.add(DbMigrateCommand())\n    return app\n\n\ndef main() -> int:\n    return create_app().run()\n\n\nif __name__ == \"__main__\":\n    raise SystemExit(main())\n",[19,923,924,929,941,945,957,961,965,976,996,1001,1006,1014,1018,1022,1036,1043,1047,1051,1067],{"__ignoreMap":118},[122,925,926],{"class":124,"line":125},[122,927,928],{"class":128},"# src\u002Fgreeter\u002Fapp.py\n",[122,930,931,933,936,938],{"class":124,"line":132},[122,932,136],{"class":135},[122,934,935],{"class":146}," cleo.application ",[122,937,165],{"class":135},[122,939,940],{"class":146}," Application\n",[122,942,943],{"class":124,"line":150},[122,944,154],{"emptyLinePlaceholder":153},[122,946,947,949,952,954],{"class":124,"line":157},[122,948,136],{"class":135},[122,950,951],{"class":146}," greeter.commands ",[122,953,165],{"class":135},[122,955,956],{"class":146}," DbMigrateCommand, GreetCommand\n",[122,958,959],{"class":124,"line":171},[122,960,154],{"emptyLinePlaceholder":153},[122,962,963],{"class":124,"line":184},[122,964,154],{"emptyLinePlaceholder":153},[122,966,967,970,973],{"class":124,"line":189},[122,968,969],{"class":135},"def",[122,971,972],{"class":200}," create_app",[122,974,975],{"class":146},"() -> Application:\n",[122,977,978,981,983,986,989,991,994],{"class":124,"line":194},[122,979,980],{"class":146},"    app ",[122,982,218],{"class":135},[122,984,985],{"class":146}," Application(",[122,987,988],{"class":221},"\"greeter\"",[122,990,90],{"class":146},[122,992,993],{"class":221},"\"0.3.0\"",[122,995,471],{"class":146},[122,997,998],{"class":124,"line":212},[122,999,1000],{"class":146},"    app.add(GreetCommand())\n",[122,1002,1003],{"class":124,"line":225},[122,1004,1005],{"class":146},"    app.add(DbMigrateCommand())\n",[122,1007,1008,1011],{"class":124,"line":236},[122,1009,1010],{"class":135},"    return",[122,1012,1013],{"class":146}," app\n",[122,1015,1016],{"class":124,"line":273},[122,1017,154],{"emptyLinePlaceholder":153},[122,1019,1020],{"class":124,"line":284},[122,1021,154],{"emptyLinePlaceholder":153},[122,1023,1024,1026,1029,1032,1034],{"class":124,"line":319},[122,1025,969],{"class":135},[122,1027,1028],{"class":200}," main",[122,1030,1031],{"class":146},"() -> ",[122,1033,385],{"class":139},[122,1035,388],{"class":146},[122,1037,1038,1040],{"class":124,"line":362},[122,1039,1010],{"class":135},[122,1041,1042],{"class":146}," create_app().run()\n",[122,1044,1045],{"class":124,"line":368},[122,1046,154],{"emptyLinePlaceholder":153},[122,1048,1049],{"class":124,"line":373},[122,1050,154],{"emptyLinePlaceholder":153},[122,1052,1053,1056,1059,1062,1065],{"class":124,"line":391},[122,1054,1055],{"class":135},"if",[122,1057,1058],{"class":139}," __name__",[122,1060,1061],{"class":135}," ==",[122,1063,1064],{"class":221}," \"__main__\"",[122,1066,388],{"class":146},[122,1068,1069,1072,1075],{"class":124,"line":416},[122,1070,1071],{"class":135},"    raise",[122,1073,1074],{"class":139}," SystemExit",[122,1076,1077],{"class":146},"(main())\n",[10,1079,1080,1081,1084,1085,1088],{},"A ",[19,1082,1083],{},"create_app()"," factory keeps construction separate from running, which tests use below. The ",[19,1086,1087],{},"main()"," function is the console-script entry point.",[42,1090,1092],{"id":1091},"console-io-styles-and-verbosity","Console I\u002FO, styles and verbosity",[10,1094,1095,1096,90,1098,1101,1102,1105,1106,90,1109,90,1112,90,1115,1118,1119,1122,1123,90,1126,30,1129,1132,1133,90,1136,90,1139,30,1142,1145],{},"Cleo's output layer is its biggest difference from function-based frameworks. Inside ",[19,1097,21],{},[19,1099,1100],{},"self.line()"," writes to stdout and ",[19,1103,1104],{},"self.line_error()"," to stderr; both understand inline style tags — ",[19,1107,1108],{},"\u003Cinfo>",[19,1110,1111],{},"\u003Ccomment>",[19,1113,1114],{},"\u003Cquestion>",[19,1116,1117],{},"\u003Cerror>"," — that render as colours on a terminal and disappear when output is redirected or ",[19,1120,1121],{},"--no-ansi"," is passed. ",[19,1124,1125],{},"self.table()",[19,1127,1128],{},"self.progress_bar()",[19,1130,1131],{},"self.spin()"," cover tabular and long-running output, and ",[19,1134,1135],{},"self.confirm()",[19,1137,1138],{},"self.ask()",[19,1140,1141],{},"self.choice()",[19,1143,1144],{},"self.secret()"," handle questions.",[109,1147],{"name":1148},"cleo-io-matrix",[10,1150,1151,1152,90,1155,1158,1159,1162,1163,30,1165,1168,1169,90,1172,30,1175,1178,1179,1183,1184,1187],{},"Every Cleo application also gets global options for free: ",[19,1153,1154],{},"-q\u002F--quiet",[19,1156,1157],{},"-v\u002F-vv\u002F-vvv"," verbosity levels, ",[19,1160,1161],{},"--ansi","\u002F",[19,1164,1121],{},[19,1166,1167],{},"-n\u002F--no-interaction",". Commands check verbosity with ",[19,1170,1171],{},"self.io.is_verbose()",[19,1173,1174],{},"is_very_verbose()",[19,1176,1177],{},"is_debug()",", which maps neatly onto the logging advice in ",[36,1180,1182],{"href":1181},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags\u002F","adding verbose and quiet logging flags",". With ",[19,1185,1186],{},"-n",", questions return their defaults without prompting — exactly the behaviour CI needs, and the reason the confirmation above defaults to \"no\".",[109,1189],{"name":1190},"cleo-terminal",[42,1192,1194],{"id":1193},"arguments-and-options-in-more-depth","Arguments and options in more depth",[10,1196,1197,1198,30,1201,1204],{},"Cleo's ",[19,1199,1200],{},"argument()",[19,1202,1203],{},"option()"," helpers cover the shapes most commands need, but the flags interact in ways worth knowing before you design a command.",[113,1206,1208],{"className":115,"code":1207,"language":117,"meta":118,"style":118},"from cleo.helpers import argument, option\n\narguments = [\n    argument(\"paths\", description=\"Files to process.\", multiple=True),       # one or more\n    argument(\"target\", description=\"Where to write.\", optional=True, default=\"out\"),\n]\noptions = [\n    option(\"force\", \"f\", description=\"Overwrite.\", flag=True),               # --force \u002F -f\n    option(\"level\", \"l\", description=\"0-9.\", flag=False, default=\"6\"),       # --level 9\n    option(\"tag\", None, description=\"Repeatable.\", flag=False, multiple=True),  # --tag a --tag b\n    option(\"color\", None, description=\"Optional value.\", flag=False, value_required=False),\n]\n",[19,1209,1210,1220,1224,1233,1265,1300,1304,1313,1349,1392,1434,1473],{"__ignoreMap":118},[122,1211,1212,1214,1216,1218],{"class":124,"line":125},[122,1213,136],{"class":135},[122,1215,176],{"class":146},[122,1217,165],{"class":135},[122,1219,181],{"class":146},[122,1221,1222],{"class":124,"line":132},[122,1223,154],{"emptyLinePlaceholder":153},[122,1225,1226,1229,1231],{"class":124,"line":150},[122,1227,1228],{"class":146},"arguments ",[122,1230,218],{"class":135},[122,1232,281],{"class":146},[122,1234,1235,1238,1241,1243,1245,1247,1250,1252,1255,1257,1259,1262],{"class":124,"line":157},[122,1236,1237],{"class":146},"    argument(",[122,1239,1240],{"class":221},"\"paths\"",[122,1242,90],{"class":146},[122,1244,93],{"class":252},[122,1246,218],{"class":135},[122,1248,1249],{"class":221},"\"Files to process.\"",[122,1251,90],{"class":146},[122,1253,1254],{"class":252},"multiple",[122,1256,218],{"class":135},[122,1258,267],{"class":139},[122,1260,1261],{"class":146},"),       ",[122,1263,1264],{"class":128},"# one or more\n",[122,1266,1267,1269,1272,1274,1276,1278,1281,1283,1285,1287,1289,1291,1293,1295,1298],{"class":124,"line":171},[122,1268,1237],{"class":146},[122,1270,1271],{"class":221},"\"target\"",[122,1273,90],{"class":146},[122,1275,93],{"class":252},[122,1277,218],{"class":135},[122,1279,1280],{"class":221},"\"Where to write.\"",[122,1282,90],{"class":146},[122,1284,262],{"class":252},[122,1286,218],{"class":135},[122,1288,267],{"class":139},[122,1290,90],{"class":146},[122,1292,352],{"class":252},[122,1294,218],{"class":135},[122,1296,1297],{"class":221},"\"out\"",[122,1299,316],{"class":146},[122,1301,1302],{"class":124,"line":184},[122,1303,734],{"class":146},[122,1305,1306,1309,1311],{"class":124,"line":189},[122,1307,1308],{"class":146},"options ",[122,1310,218],{"class":135},[122,1312,281],{"class":146},[122,1314,1315,1318,1321,1323,1326,1328,1330,1332,1335,1337,1339,1341,1343,1346],{"class":124,"line":194},[122,1316,1317],{"class":146},"    option(",[122,1319,1320],{"class":221},"\"force\"",[122,1322,90],{"class":146},[122,1324,1325],{"class":221},"\"f\"",[122,1327,90],{"class":146},[122,1329,93],{"class":252},[122,1331,218],{"class":135},[122,1333,1334],{"class":221},"\"Overwrite.\"",[122,1336,90],{"class":146},[122,1338,309],{"class":252},[122,1340,218],{"class":135},[122,1342,267],{"class":139},[122,1344,1345],{"class":146},"),               ",[122,1347,1348],{"class":128},"# --force \u002F -f\n",[122,1350,1351,1353,1356,1358,1361,1363,1365,1367,1370,1372,1374,1376,1378,1380,1382,1384,1387,1389],{"class":124,"line":212},[122,1352,1317],{"class":146},[122,1354,1355],{"class":221},"\"level\"",[122,1357,90],{"class":146},[122,1359,1360],{"class":221},"\"l\"",[122,1362,90],{"class":146},[122,1364,93],{"class":252},[122,1366,218],{"class":135},[122,1368,1369],{"class":221},"\"0-9.\"",[122,1371,90],{"class":146},[122,1373,309],{"class":252},[122,1375,218],{"class":135},[122,1377,347],{"class":139},[122,1379,90],{"class":146},[122,1381,352],{"class":252},[122,1383,218],{"class":135},[122,1385,1386],{"class":221},"\"6\"",[122,1388,1261],{"class":146},[122,1390,1391],{"class":128},"# --level 9\n",[122,1393,1394,1396,1399,1401,1403,1405,1407,1409,1412,1414,1416,1418,1420,1422,1424,1426,1428,1431],{"class":124,"line":225},[122,1395,1317],{"class":146},[122,1397,1398],{"class":221},"\"tag\"",[122,1400,90],{"class":146},[122,1402,686],{"class":139},[122,1404,90],{"class":146},[122,1406,93],{"class":252},[122,1408,218],{"class":135},[122,1410,1411],{"class":221},"\"Repeatable.\"",[122,1413,90],{"class":146},[122,1415,309],{"class":252},[122,1417,218],{"class":135},[122,1419,347],{"class":139},[122,1421,90],{"class":146},[122,1423,1254],{"class":252},[122,1425,218],{"class":135},[122,1427,267],{"class":139},[122,1429,1430],{"class":146},"),  ",[122,1432,1433],{"class":128},"# --tag a --tag b\n",[122,1435,1436,1438,1441,1443,1445,1447,1449,1451,1454,1456,1458,1460,1462,1464,1467,1469,1471],{"class":124,"line":236},[122,1437,1317],{"class":146},[122,1439,1440],{"class":221},"\"color\"",[122,1442,90],{"class":146},[122,1444,686],{"class":139},[122,1446,90],{"class":146},[122,1448,93],{"class":252},[122,1450,218],{"class":135},[122,1452,1453],{"class":221},"\"Optional value.\"",[122,1455,90],{"class":146},[122,1457,309],{"class":252},[122,1459,218],{"class":135},[122,1461,347],{"class":139},[122,1463,90],{"class":146},[122,1465,1466],{"class":252},"value_required",[122,1468,218],{"class":135},[122,1470,347],{"class":139},[122,1472,316],{"class":146},[122,1474,1475],{"class":124,"line":273},[122,1476,734],{"class":146},[47,1478,1479,1494,1502,1524],{},[50,1480,1481,1486,1487,1489,1490,1493],{},[14,1482,1483],{},[19,1484,1485],{},"flag=True"," (the default for ",[19,1488,1203],{},") makes a boolean switch. Set ",[19,1491,1492],{},"flag=False"," for an option that takes a value — forgetting this is the most common Cleo mistake, and it shows up as \"option does not accept a value\".",[50,1495,1496,1501],{},[14,1497,1498],{},[19,1499,1500],{},"multiple=True"," on an option collects repeated values into a list; on an argument it makes the argument variadic, and only the last argument may be variadic.",[50,1503,1504,1509,1510,1513,1514,90,1516,1519,1520,1523],{},[14,1505,1506],{},[19,1507,1508],{},"value_required=False"," creates an option whose value is optional: ",[19,1511,1512],{},"--color"," alone gives ",[19,1515,686],{},[19,1517,1518],{},"--color=auto"," gives ",[19,1521,1522],{},"\"auto\"",", and leaving it out gives the default. Useful, but harder to explain in help; prefer two clear options when you can.",[50,1525,1526,1529,1530,1533,1534,1536],{},[14,1527,1528],{},"Defaults are returned as given."," ",[19,1531,1532],{},"default=\"6\""," comes back as the string ",[19,1535,1386],{},", and a value from the command line is also a string. Convert in one place — a small helper on a base command class keeps every command consistent.",[10,1538,1539,1540,1543,1544,90,1547,1550,1551,1554,1555,1557,1558,1561,1562,1564],{},"Command metadata is just as declarative. ",[19,1541,1542],{},"help"," holds a longer description shown by ",[19,1545,1546],{},"greeter help greet",[19,1548,1549],{},"aliases"," adds alternative names, and ",[19,1552,1553],{},"hidden = True"," keeps internal commands out of ",[19,1556,106],{}," while leaving them callable. Because everything is a class attribute, a base class can supply shared options — for example a ",[19,1559,1560],{},"--config"," path every command accepts — by extending ",[19,1563,99],{}," in subclasses.",[42,1566,1568],{"id":1567},"ux-considerations","UX considerations",[47,1570,1571,1593,1603,1616,1640],{},[50,1572,1573,1576,1577,1579,1580,1583,1584,1587,1588,1592],{},[14,1574,1575],{},"Usage errors exit with 1, not 2."," A missing option value or an unknown command makes Cleo print an error and return 1, the same status as a failed command. Validate values inside ",[19,1578,21],{}," and return 2 yourself for bad input, as ",[19,1581,1582],{},"GreetCommand"," does; if the distinction matters for the parser's own errors, wrap ",[19,1585,1586],{},"run()"," and test the behaviour you rely on. ",[36,1589,1591],{"href":1590},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools\u002F","Choosing exit codes for CLI tools"," explains why scripts care.",[50,1594,1595,1598,1599,1602],{},[14,1596,1597],{},"Option values are strings."," Cleo does not convert types; ",[19,1600,1601],{},"int(self.option(\"times\"))"," is your job, and so is a friendly error when it fails.",[50,1604,1605,1608,1609,1612,1613,791],{},[14,1606,1607],{},"\"Did you mean\" is built in."," Mistyping ",[19,1610,1611],{},"gret"," prints \"The command \"gret\" does not exist\" followed by a suggestion of ",[19,1614,1615],{},"greet",[50,1617,1618,1623,1624,1627,1628,1631,1632,1635,1636,791],{},[14,1619,1620,1621,791],{},"Destructive commands should honour ",[19,1622,1186],{}," Because ",[19,1625,1626],{},"--no-interaction"," makes ",[19,1629,1630],{},"confirm()"," return its default, make that default the safe choice, and offer an explicit ",[19,1633,1634],{},"--yes"," if automation needs to proceed. See ",[36,1637,1639],{"href":1638},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fadding-dry-run-and-confirmation-to-destructive-commands\u002F","adding dry run and confirmation to destructive commands",[50,1641,1642,1529,1645,1648],{},[14,1643,1644],{},"Keep data on stdout and chatter on stderr.",[19,1646,1647],{},"line_error()"," for status messages keeps piped output clean, just as with any other framework.",[42,1650,1652],{"id":1651},"testing-the-behaviour","Testing the behaviour",[10,1654,1655,1656,1659,1660,1663],{},"Cleo ships two testers. ",[19,1657,1658],{},"CommandTester"," runs one command with an argument string and optional simulated input; ",[19,1661,1662],{},"ApplicationTester"," runs the whole application, including global options and command lookup.",[113,1665,1667],{"className":115,"code":1666,"language":117,"meta":118,"style":118},"# tests\u002Ftest_commands.py\nfrom cleo.testers.application_tester import ApplicationTester\nfrom cleo.testers.command_tester import CommandTester\n\nfrom greeter.app import create_app\n\n\ndef command_tester(name: str) -> CommandTester:\n    return CommandTester(create_app().find(name))\n\n\ndef test_greet_options():\n    t = command_tester(\"greet\")\n    assert t.execute(\"Ann --yell --times 2\") == 0\n    assert t.io.fetch_output() == \"HELLO ANN\\nHELLO ANN\\n\"\n\n\ndef test_greet_rejects_non_numeric_times():\n    t = command_tester(\"greet\")\n    assert t.execute(\"--times many\") == 2\n    assert \"whole number\" in t.io.fetch_error()\n\n\ndef test_migrate_declined_by_default():\n    t = command_tester(\"db migrate\")\n    assert t.execute(inputs=\"\\n\") == 1\n    assert \"aborted\" in t.io.fetch_error()\n\n\ndef test_migrate_confirmed():\n    t = command_tester(\"db migrate\")\n    assert t.execute(inputs=\"yes\\n\") == 0\n    assert t.io.fetch_output().endswith(\"applied 3 migrations\\n\")\n\n\ndef test_dry_run_prints_plan_without_asking():\n    t = command_tester(\"db migrate\")\n    assert t.execute(\"--dry-run\") == 0\n    assert \"0005_backfill\" in t.io.fetch_output()\n\n\ndef test_verbose_flag_through_the_application():\n    app = create_app()\n    app.auto_exits(False)\n    t = ApplicationTester(app)\n    assert t.execute(\"greet Bo -v\") == 0\n    assert \"greeted Bo 1x\" in t.io.fetch_error()\n",[19,1668,1669,1674,1686,1698,1702,1714,1718,1722,1738,1745,1749,1753,1763,1778,1796,1818,1822,1826,1835,1847,1862,1875,1879,1883,1892,1905,1929,1940,1944,1948,1957,1969,1992,2008,2012,2016,2025,2037,2052,2064,2068,2072,2081,2090,2099,2108,2123],{"__ignoreMap":118},[122,1670,1671],{"class":124,"line":125},[122,1672,1673],{"class":128},"# tests\u002Ftest_commands.py\n",[122,1675,1676,1678,1681,1683],{"class":124,"line":132},[122,1677,136],{"class":135},[122,1679,1680],{"class":146}," cleo.testers.application_tester ",[122,1682,165],{"class":135},[122,1684,1685],{"class":146}," ApplicationTester\n",[122,1687,1688,1690,1693,1695],{"class":124,"line":150},[122,1689,136],{"class":135},[122,1691,1692],{"class":146}," cleo.testers.command_tester ",[122,1694,165],{"class":135},[122,1696,1697],{"class":146}," CommandTester\n",[122,1699,1700],{"class":124,"line":157},[122,1701,154],{"emptyLinePlaceholder":153},[122,1703,1704,1706,1709,1711],{"class":124,"line":171},[122,1705,136],{"class":135},[122,1707,1708],{"class":146}," greeter.app ",[122,1710,165],{"class":135},[122,1712,1713],{"class":146}," create_app\n",[122,1715,1716],{"class":124,"line":184},[122,1717,154],{"emptyLinePlaceholder":153},[122,1719,1720],{"class":124,"line":189},[122,1721,154],{"emptyLinePlaceholder":153},[122,1723,1724,1726,1729,1732,1735],{"class":124,"line":194},[122,1725,969],{"class":135},[122,1727,1728],{"class":200}," command_tester",[122,1730,1731],{"class":146},"(name: ",[122,1733,1734],{"class":139},"str",[122,1736,1737],{"class":146},") -> CommandTester:\n",[122,1739,1740,1742],{"class":124,"line":212},[122,1741,1010],{"class":135},[122,1743,1744],{"class":146}," CommandTester(create_app().find(name))\n",[122,1746,1747],{"class":124,"line":225},[122,1748,154],{"emptyLinePlaceholder":153},[122,1750,1751],{"class":124,"line":236},[122,1752,154],{"emptyLinePlaceholder":153},[122,1754,1755,1757,1760],{"class":124,"line":273},[122,1756,969],{"class":135},[122,1758,1759],{"class":200}," test_greet_options",[122,1761,1762],{"class":146},"():\n",[122,1764,1765,1768,1770,1773,1776],{"class":124,"line":284},[122,1766,1767],{"class":146},"    t ",[122,1769,218],{"class":135},[122,1771,1772],{"class":146}," command_tester(",[122,1774,1775],{"class":221},"\"greet\"",[122,1777,471],{"class":146},[122,1779,1780,1783,1786,1789,1791,1794],{"class":124,"line":319},[122,1781,1782],{"class":135},"    assert",[122,1784,1785],{"class":146}," t.execute(",[122,1787,1788],{"class":221},"\"Ann --yell --times 2\"",[122,1790,407],{"class":146},[122,1792,1793],{"class":135},"==",[122,1795,624],{"class":139},[122,1797,1798,1800,1803,1805,1808,1811,1814,1816],{"class":124,"line":362},[122,1799,1782],{"class":135},[122,1801,1802],{"class":146}," t.io.fetch_output() ",[122,1804,1793],{"class":135},[122,1806,1807],{"class":221}," \"HELLO ANN",[122,1809,1810],{"class":139},"\\n",[122,1812,1813],{"class":221},"HELLO ANN",[122,1815,1810],{"class":139},[122,1817,505],{"class":221},[122,1819,1820],{"class":124,"line":368},[122,1821,154],{"emptyLinePlaceholder":153},[122,1823,1824],{"class":124,"line":373},[122,1825,154],{"emptyLinePlaceholder":153},[122,1827,1828,1830,1833],{"class":124,"line":391},[122,1829,969],{"class":135},[122,1831,1832],{"class":200}," test_greet_rejects_non_numeric_times",[122,1834,1762],{"class":146},[122,1836,1837,1839,1841,1843,1845],{"class":124,"line":416},[122,1838,1767],{"class":146},[122,1840,218],{"class":135},[122,1842,1772],{"class":146},[122,1844,1775],{"class":221},[122,1846,471],{"class":146},[122,1848,1849,1851,1853,1856,1858,1860],{"class":124,"line":424},[122,1850,1782],{"class":135},[122,1852,1785],{"class":146},[122,1854,1855],{"class":221},"\"--times many\"",[122,1857,407],{"class":146},[122,1859,1793],{"class":135},[122,1861,480],{"class":139},[122,1863,1864,1866,1869,1872],{"class":124,"line":448},[122,1865,1782],{"class":135},[122,1867,1868],{"class":221}," \"whole number\"",[122,1870,1871],{"class":135}," in",[122,1873,1874],{"class":146}," t.io.fetch_error()\n",[122,1876,1877],{"class":124,"line":459},[122,1878,154],{"emptyLinePlaceholder":153},[122,1880,1881],{"class":124,"line":474},[122,1882,154],{"emptyLinePlaceholder":153},[122,1884,1885,1887,1890],{"class":124,"line":483},[122,1886,969],{"class":135},[122,1888,1889],{"class":200}," test_migrate_declined_by_default",[122,1891,1762],{"class":146},[122,1893,1894,1896,1898,1900,1903],{"class":124,"line":508},[122,1895,1767],{"class":146},[122,1897,218],{"class":135},[122,1899,1772],{"class":146},[122,1901,1902],{"class":221},"\"db migrate\"",[122,1904,471],{"class":146},[122,1906,1907,1909,1911,1914,1916,1919,1921,1923,1925,1927],{"class":124,"line":522},[122,1908,1782],{"class":135},[122,1910,1785],{"class":146},[122,1912,1913],{"class":252},"inputs",[122,1915,218],{"class":135},[122,1917,1918],{"class":221},"\"",[122,1920,1810],{"class":139},[122,1922,1918],{"class":221},[122,1924,407],{"class":146},[122,1926,1793],{"class":135},[122,1928,880],{"class":139},[122,1930,1931,1933,1936,1938],{"class":124,"line":533},[122,1932,1782],{"class":135},[122,1934,1935],{"class":221}," \"aborted\"",[122,1937,1871],{"class":135},[122,1939,1874],{"class":146},[122,1941,1942],{"class":124,"line":551},[122,1943,154],{"emptyLinePlaceholder":153},[122,1945,1946],{"class":124,"line":577},[122,1947,154],{"emptyLinePlaceholder":153},[122,1949,1950,1952,1955],{"class":124,"line":587},[122,1951,969],{"class":135},[122,1953,1954],{"class":200}," test_migrate_confirmed",[122,1956,1762],{"class":146},[122,1958,1959,1961,1963,1965,1967],{"class":124,"line":618},[122,1960,1767],{"class":146},[122,1962,218],{"class":135},[122,1964,1772],{"class":146},[122,1966,1902],{"class":221},[122,1968,471],{"class":146},[122,1970,1971,1973,1975,1977,1979,1982,1984,1986,1988,1990],{"class":124,"line":627},[122,1972,1782],{"class":135},[122,1974,1785],{"class":146},[122,1976,1913],{"class":252},[122,1978,218],{"class":135},[122,1980,1981],{"class":221},"\"yes",[122,1983,1810],{"class":139},[122,1985,1918],{"class":221},[122,1987,407],{"class":146},[122,1989,1793],{"class":135},[122,1991,624],{"class":139},[122,1993,1994,1996,1999,2002,2004,2006],{"class":124,"line":632},[122,1995,1782],{"class":135},[122,1997,1998],{"class":146}," t.io.fetch_output().endswith(",[122,2000,2001],{"class":221},"\"applied 3 migrations",[122,2003,1810],{"class":139},[122,2005,1918],{"class":221},[122,2007,471],{"class":146},[122,2009,2010],{"class":124,"line":637},[122,2011,154],{"emptyLinePlaceholder":153},[122,2013,2014],{"class":124,"line":651},[122,2015,154],{"emptyLinePlaceholder":153},[122,2017,2018,2020,2023],{"class":124,"line":661},[122,2019,969],{"class":135},[122,2021,2022],{"class":200}," test_dry_run_prints_plan_without_asking",[122,2024,1762],{"class":146},[122,2026,2027,2029,2031,2033,2035],{"class":124,"line":671},[122,2028,1767],{"class":146},[122,2030,218],{"class":135},[122,2032,1772],{"class":146},[122,2034,1902],{"class":221},[122,2036,471],{"class":146},[122,2038,2039,2041,2043,2046,2048,2050],{"class":124,"line":704},[122,2040,1782],{"class":135},[122,2042,1785],{"class":146},[122,2044,2045],{"class":221},"\"--dry-run\"",[122,2047,407],{"class":146},[122,2049,1793],{"class":135},[122,2051,624],{"class":139},[122,2053,2054,2056,2059,2061],{"class":124,"line":709},[122,2055,1782],{"class":135},[122,2057,2058],{"class":221}," \"0005_backfill\"",[122,2060,1871],{"class":135},[122,2062,2063],{"class":146}," t.io.fetch_output()\n",[122,2065,2066],{"class":124,"line":737},[122,2067,154],{"emptyLinePlaceholder":153},[122,2069,2070],{"class":124,"line":742},[122,2071,154],{"emptyLinePlaceholder":153},[122,2073,2074,2076,2079],{"class":124,"line":755},[122,2075,969],{"class":135},[122,2077,2078],{"class":200}," test_verbose_flag_through_the_application",[122,2080,1762],{"class":146},[122,2082,2083,2085,2087],{"class":124,"line":800},[122,2084,980],{"class":146},[122,2086,218],{"class":135},[122,2088,2089],{"class":146}," create_app()\n",[122,2091,2092,2095,2097],{"class":124,"line":813},[122,2093,2094],{"class":146},"    app.auto_exits(",[122,2096,347],{"class":139},[122,2098,471],{"class":146},[122,2100,2101,2103,2105],{"class":124,"line":820},[122,2102,1767],{"class":146},[122,2104,218],{"class":135},[122,2106,2107],{"class":146}," ApplicationTester(app)\n",[122,2109,2110,2112,2114,2117,2119,2121],{"class":124,"line":863},[122,2111,1782],{"class":135},[122,2113,1785],{"class":146},[122,2115,2116],{"class":221},"\"greet Bo -v\"",[122,2118,407],{"class":146},[122,2120,1793],{"class":135},[122,2122,624],{"class":139},[122,2124,2125,2127,2130,2132],{"class":124,"line":875},[122,2126,1782],{"class":135},[122,2128,2129],{"class":221}," \"greeted Bo 1x\"",[122,2131,1871],{"class":135},[122,2133,1874],{"class":146},[10,2135,2136,2137,2140,2141,2144,2145,2148,2149,791],{},"Note the ",[19,2138,2139],{},"auto_exits(False)"," call: by default ",[19,2142,2143],{},"Application.run()"," calls ",[19,2146,2147],{},"sys.exit",", which would end the test run. The testers capture both streams separately, so tests can assert that data and diagnostics land where they should. Interactive prompts write their question text to the error stream, which is why the \"declined\" test checks ",[19,2150,2151],{},"fetch_error()",[42,2153,2155],{"id":2154},"structuring-a-larger-cleo-application","Structuring a larger Cleo application",[10,2157,2158,2159,2162,2163,2165,2166,2170,2171,2174],{},"The class model pays off when an application has dozens of commands. Three habits keep it manageable. First, put shared behaviour — loading configuration, creating an API client, converting common options — on a base command, and create expensive services lazily on first use so ",[19,2160,2161],{},"greeter --version"," stays instant. Second, keep ",[19,2164,21],{}," short: parse and validate, call a plain function from your core package, and render the result; the core function is then testable without any Cleo machinery, the same separation recommended in ",[36,2167,2169],{"href":2168},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands\u002F","dependency injection patterns for CLI commands",". Third, register commands through a ",[19,2172,2173],{},"FactoryCommandLoader"," so that each command's module, and its imports, load only when that command runs. Poetry follows all three, which is why a tool with that many commands still starts quickly.",[42,2176,2178],{"id":2177},"conclusion","Conclusion",[10,2180,2181,2182,2184,2185,30,2187,2189],{},"Cleo trades decorators for command classes and gives you a mature console layer in return: styled output, tables, progress, questions, verbosity levels and non-interactive mode, all consistent across commands. Declare arguments and options as class attributes, convert and validate values in ",[19,2183,21],{},", return 2 for bad input yourself, and test with ",[19,2186,1658],{},[19,2188,1662],{},". For applications with many namespaced commands — the kind Poetry is — it is a well-proven structure.",[42,2191,2193],{"id":2192},"frequently-asked-questions","Frequently asked questions",[2195,2196,2198],"h3",{"id":2197},"can-i-share-setup-code-between-cleo-commands","Can I share setup code between Cleo commands?",[10,2200,2201,2202,2204],{},"Yes: create a base class that inherits from ",[19,2203,85],{}," and provides helpers or lazily-created services, and have your commands inherit from it. Poetry does exactly this with its own base command. Keep the base class thin so commands stay readable.",[2195,2206,2208],{"id":2207},"how-do-i-add-shell-completion","How do I add shell completion?",[10,2210,2211,2212,30,2215,2218,2219,2222,2223,791],{},"Register Cleo's completions command — ",[19,2213,2214],{},"from cleo.commands.completions_command import CompletionsCommand",[19,2216,2217],{},"app.add(CompletionsCommand())"," — then users run ",[19,2220,2221],{},"mytool completions bash"," and install the output. The general installation steps are in ",[36,2224,2226],{"href":2225},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Finstalling-shell-completion-for-bash-zsh-fish\u002F","installing shell completion for bash, zsh and fish",[2195,2228,2230],{"id":2229},"does-cleo-support-lazy-loading-of-commands","Does Cleo support lazy loading of commands?",[10,2232,2233,2234,2236,2237,791],{},"Yes, through a command loader (",[19,2235,2173],{},") that maps names to factory functions, so a command's module is imported only when it runs. That keeps startup fast for large applications; see ",[36,2238,2240],{"href":2239},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup\u002F","lazy-loading subcommands for faster startup",[2195,2242,2244],{"id":2243},"should-i-choose-cleo-over-click-for-a-new-project","Should I choose Cleo over Click for a new project?",[10,2246,2247],{},"Choose Cleo if the class-based model and its console layer fit how your team builds applications. Choose Click or Typer for the larger ecosystem — plugins, documentation generators and community answers. Both are capable of large applications.",[42,2249,2251],{"id":2250},"related","Related",[47,2253,2254,2260,2266,2272,2278],{},[50,2255,2256,2257],{},"Up: ",[36,2258,2259],{"href":38},"Alternative Python CLI frameworks",[50,2261,2262],{},[36,2263,2265],{"href":2264},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts\u002F","Building a CLI with Cyclopts",[50,2267,2268],{},[36,2269,2271],{"href":2270},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fusage-string-driven-clis-with-docopt-ng\u002F","Usage-string driven CLIs with docopt-ng",[50,2273,2274],{},[36,2275,2277],{"href":2276},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-a-cli-with-subcommands-in-click\u002F","Building a CLI with subcommands in Click",[50,2279,2280],{},[36,2281,2283],{"href":2282},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis\u002F","Poetry entry points and scripts for CLIs",[2285,2286,2287],"style",{},"html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}html pre.shiki code .szBVR, html code.shiki .szBVR{--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html pre.shiki code .s4XuR, html code.shiki .s4XuR{--shiki-default:#E36209;--shiki-dark:#FFAB70}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":118,"searchDepth":132,"depth":132,"links":2289},[2290,2291,2292,2293,2294,2295,2296,2297,2298,2304],{"id":44,"depth":132,"text":45},{"id":74,"depth":132,"text":75},{"id":1091,"depth":132,"text":1092},{"id":1193,"depth":132,"text":1194},{"id":1567,"depth":132,"text":1568},{"id":1651,"depth":132,"text":1652},{"id":2154,"depth":132,"text":2155},{"id":2177,"depth":132,"text":2178},{"id":2192,"depth":132,"text":2193,"children":2299},[2300,2301,2302,2303],{"id":2197,"depth":150,"text":2198},{"id":2207,"depth":150,"text":2208},{"id":2229,"depth":150,"text":2230},{"id":2243,"depth":150,"text":2244},{"id":2250,"depth":132,"text":2251},"2026-10-02","Build a namespaced CLI with Cleo, the framework behind Poetry: command classes, options, styled output, verbosity, questions and CommandTester tests.","intermediate",false,"md",{},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo",{"title":5,"description":2306},"modern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo\u002Findex",[55,2315,25,2316],"frameworks","testing","pjLAhqAq1jLjKzpgaVOxIfDbQd4mKVkoIKZtFaAiCos",[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,2667,2670,2673,2676,2679,2682,2685,2688,2691,2694,2697,2700,2703,2706,2709,2712,2715,2718,2721,2724,2727,2730,2733,2736,2738,2739,2742,2745,2748,2751,2754,2757,2760,2763,2766,2769,2772,2775,2778,2781,2784,2787,2790,2793,2796,2799,2802,2805,2808,2811,2814,2817,2820,2823,2826,2829,2832,2835,2838,2841,2844,2847,2850,2853,2856,2859,2862,2865,2868,2871,2874,2877,2880,2883,2886,2889,2892,2895,2897,2900,2903,2906,2909,2912,2915,2918,2921,2924,2927,2930,2933,2936,2939,2942,2945,2948,2951,2954,2957,2960,2963,2966,2969,2972,2975,2978,2981,2984,2987,2990,2993,2996,2999,3002,3005,3008,3011,3014,3017,3020,3023,3026,3029,3032,3035,3038,3041,3044,3047,3050,3053,3056,3059,3062,3065,3068,3071,3074,3077,3080,3083,3086,3089,3092,3095,3098,3101,3104,3107,3110,3113,3116,3119,3122,3125,3128,3131,3134,3137,3140,3143,3146,3149,3152,3155,3158],{"path":2320,"title":2321},"\u002Fabout","About Python CLI Toolcraft",{"path":2323,"title":2324},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":2326,"title":2327},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":2329,"title":2330},"\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":2332,"title":2333},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":2335,"title":2336},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":2338,"title":2339},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-urls-hosts-and-ports","Validating URLs, Hosts and Ports in Python CLI Arguments",{"path":2341,"title":2342},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":2344,"title":2345},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbrowsing-records-with-a-textual-datatable","Browsing Records with a Textual DataTable Picker",{"path":2347,"title":2348},"\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":2350,"title":2351},"\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":2353,"title":2354},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":2356,"title":2357},"\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":2359,"title":2360},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fstyling-textual-apps-with-tcss","Styling Textual Apps with TCSS",{"path":2362,"title":2363},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":2365,"title":2366},"\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":2368,"title":2369},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fdocumenting-environment-variables-in-help","Documenting Environment Variables in CLI Help",{"path":2371,"title":2372},"\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":2374,"title":2375},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":2377,"title":2378},"\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":2380,"title":2381},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":2383,"title":2384},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":2386,"title":2387},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":2389,"title":2390},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":2392,"title":2393},"\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":2395,"title":2396},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fhandling-ansi-escape-codes-on-windows-consoles","Handling ANSI Escape Codes on Windows Consoles",{"path":2398,"title":2399},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":2401,"title":2402},"\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":2404,"title":2405},"\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":2407,"title":2408},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":2410,"title":2411},"\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":2413,"title":2414},"\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":2416,"title":2417},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":2419,"title":2420},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":2422,"title":2423},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":2425,"title":2426},"\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":2428,"title":2429},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fwriting-crash-reports-users-can-send","Writing Crash Reports Users Can Send",{"path":2431,"title":2432},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":2434,"title":2435},"\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":2437,"title":2438},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":2440,"title":2441},"\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":2443,"title":2444},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":2446,"title":2447},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":2449,"title":2450},"\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":2452,"title":2453},"\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":2455,"title":2456},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":2458,"title":2459},"\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":2461,"title":2462},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":2464,"title":2465},"\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":2467,"title":2468},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":2470,"title":2471},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":2473,"title":2474},"\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":2476,"title":2477},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":2479,"title":2480},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":2482,"title":2483},"\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":2485,"title":2486},"\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":2488,"title":2489},"\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":2491,"title":2492},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis","Output Formats for Data-Heavy Python CLIs",{"path":2494,"title":2495},"\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":2497,"title":2498},"\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":2500,"title":2501},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fargcomplete-for-argparse-clis","Tab Completion for argparse CLIs with argcomplete",{"path":2503,"title":2504},"\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":2506,"title":2507},"\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":2509,"title":2510},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":2512,"title":2513},"\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":2515,"title":2516},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages","Shipping Shell Completion Scripts with a Python CLI",{"path":2518,"title":2519},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":2521,"title":2522},"\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":2524,"title":2525},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":2527,"title":2528},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":2530,"title":2531},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Flogging-with-structlog-in-a-cli","Logging with structlog in a Python CLI",{"path":2533,"title":2534},"\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":2536,"title":2537},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":2539,"title":2540},"\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":2542,"title":2543},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":2545,"title":2546},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":2548,"title":2549},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":2551,"title":2552},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":2554,"title":2555},"\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":2557,"title":2558},"\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":2560,"title":2561},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":2563,"title":2564},"\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":2566,"title":2567},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":2569,"title":2570},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":2572,"title":2573},"\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":2575,"title":2576},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":2578,"title":2579},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":2581,"title":2582},"\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":2584,"title":2585},"\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":2587,"title":2588},"\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":2590,"title":2591},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":2593,"title":2594},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":2596,"title":2597},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":2599,"title":2600},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":2602,"title":2603},"\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":2605,"title":2606},"\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":2608,"title":2609},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fstructured-concurrency-with-taskgroups-in-clis","Structured Concurrency with TaskGroups in Python CLIs",{"path":2611,"title":2612},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":2614,"title":2615},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":2617,"title":2618},"\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":2620,"title":2621},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":2623,"title":2624},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":2626,"title":2627},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":2629,"title":2630},"\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":2632,"title":2633},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":2635,"title":2636},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":2638,"title":2639},"\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":2641,"title":2642},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis","Local State and SQLite in Python CLIs",{"path":2644,"title":2645},"\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":2647,"title":2648},"\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":2650,"title":2651},"\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":2653,"title":2654},"\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":2656,"title":2657},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":2659,"title":2660},"\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":2662,"title":2663},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":2665,"title":2666},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Freloading-config-on-sighup","Reloading Configuration on SIGHUP in a Python CLI",{"path":2668,"title":2669},"\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":2671,"title":2672},"\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":2674,"title":2675},"\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":2677,"title":2678},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":2680,"title":2681},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":2683,"title":2684},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":2686,"title":2687},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":2689,"title":2690},"\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":2692,"title":2693},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fpiping-between-subprocesses-in-python","Piping Between Subprocesses in Python Without a Shell",{"path":2695,"title":2696},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":2698,"title":2699},"\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":2701,"title":2702},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":2704,"title":2705},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":2707,"title":2708},"\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":2710,"title":2711},"\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":2713,"title":2714},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Frefreshing-expired-tokens-automatically","Refreshing Expired Tokens Automatically in a Python CLI",{"path":2716,"title":2717},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":2719,"title":2720},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":2722,"title":2723},"\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":2725,"title":2726},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis","Update Checks, Upgrade Commands and Telemetry for Python CLIs",{"path":2728,"title":2729},"\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":2731,"title":2732},"\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":2734,"title":2735},"\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":1162,"title":2737},"Python CLI Toolcraft",{"path":2311,"title":5},{"path":2740,"title":2741},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts","Building a Type-Hinted Python CLI with Cyclopts",{"path":2743,"title":2744},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks","Beyond Click and Typer: Alternative Python CLI Frameworks",{"path":2746,"title":2747},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fquick-clis-from-functions-with-python-fire","Quick CLIs from Functions with Python Fire",{"path":2749,"title":2750},"\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":2752,"title":2753},"\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":2755,"title":2756},"\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":2758,"title":2759},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fguarding-startup-with-import-tests","Guarding CLI Startup with Import Tests",{"path":2761,"title":2762},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":2764,"title":2765},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":2767,"title":2768},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":2770,"title":2771},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":2773,"title":2774},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":2776,"title":2777},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":2779,"title":2780},"\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":2782,"title":2783},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":2785,"title":2786},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":2788,"title":2789},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":2791,"title":2792},"\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":2794,"title":2795},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":2797,"title":2798},"\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":2800,"title":2801},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fdesigning-idempotent-commands","Designing Idempotent Commands in a Python CLI",{"path":2803,"title":2804},"\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":2806,"title":2807},"\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":2809,"title":2810},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":2812,"title":2813},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":2815,"title":2816},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fpositional-arguments-vs-options","Positional Arguments vs Options: Designing a CLI Signature",{"path":2818,"title":2819},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":2821,"title":2822},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":2824,"title":2825},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":2827,"title":2828},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":2830,"title":2831},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures","Isolating Plugin Failures in an Extensible Python CLI",{"path":2833,"title":2834},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli","Testing Plugins Against the Host CLI",{"path":2836,"title":2837},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":2839,"title":2840},"\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":2842,"title":2843},"\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":2845,"title":2846},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":2848,"title":2849},"\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":2851,"title":2852},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":2854,"title":2855},"\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":2857,"title":2858},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically","Registering CLI Commands from Modules Automatically",{"path":2860,"title":2861},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":2863,"title":2864},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":2866,"title":2867},"\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":2869,"title":2870},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":2872,"title":2873},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":2875,"title":2876},"\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":2878,"title":2879},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":2881,"title":2882},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":2884,"title":2885},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":2887,"title":2888},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-commands-that-call-subprocesses","Testing Python CLI Commands That Call Subprocesses",{"path":2890,"title":2891},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":2893,"title":2894},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands","Transcript Tests for Python CLI Commands",{"path":2896,"title":2277},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-a-cli-with-subcommands-in-click",{"path":2898,"title":2899},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":2901,"title":2902},"\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":2904,"title":2905},"\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":2907,"title":2908},"\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":2910,"title":2911},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":2913,"title":2914},"\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":2916,"title":2917},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":2919,"title":2920},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":2922,"title":2923},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":2925,"title":2926},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":2928,"title":2929},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":2931,"title":2932},"\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":2934,"title":2935},"\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":2937,"title":2938},"\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":2940,"title":2941},"\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":2943,"title":2944},"\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":2946,"title":2947},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":2949,"title":2950},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":2952,"title":2953},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":2955,"title":2956},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":2958,"title":2959},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftemplate-variables-and-conditional-files","Template Variables and Conditional Files in CLI Templates",{"path":2961,"title":2962},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftesting-a-project-template-with-pytest","Testing a CLI Project Template with pytest",{"path":2964,"title":2965},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fupdating-generated-projects-with-copier-update","Updating Generated CLI Projects with copier update",{"path":2967,"title":2968},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":2970,"title":2971},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":2973,"title":2974},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fcode-signing-and-notarizing-cli-binaries","Code Signing and Notarizing Python CLI Binaries",{"path":2976,"title":2977},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":2979,"title":2980},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":2982,"title":2983},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":2985,"title":2986},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Freducing-pyinstaller-binary-size","Reducing the Size of a PyInstaller CLI Binary",{"path":2988,"title":2989},"\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":2991,"title":2992},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":2994,"title":2995},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":2997,"title":2998},"\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":3000,"title":3001},"\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":3003,"title":3004},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":3006,"title":3007},"\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":3009,"title":3010},"\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":3012,"title":3013},"\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":3015,"title":3016},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":3018,"title":3019},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fbumping-versions-consistently-across-a-cli-project","Bumping Versions Consistently Across a Python CLI Project",{"path":3021,"title":3022},"\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":3024,"title":3025},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":3027,"title":3028},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":3030,"title":3031},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":3033,"title":3034},"\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":3036,"title":3037},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":3039,"title":3040},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":3042,"title":3043},"\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":3045,"title":3046},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":3048,"title":3049},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":3051,"title":3052},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Foptional-dependencies-and-extras-for-clis","Optional Dependencies and Extras for Python CLIs",{"path":3054,"title":3055},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":3057,"title":3058},"\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":3060,"title":3061},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fdynamic-versioning-with-poetry-plugins","Dynamic Versioning for a Poetry CLI from Git Tags",{"path":3063,"title":3064},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":3066,"title":3067},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmanaging-poetry-lock-files-for-cli-tools","Managing Poetry Lock Files for CLI Tools",{"path":3069,"title":3070},"\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":3072,"title":3073},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":3075,"title":3076},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":3078,"title":3079},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpublishing-a-cli-with-poetry","Building and Publishing a Python CLI with Poetry",{"path":3081,"title":3082},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":3084,"title":3085},"\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":3087,"title":3088},"\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":3090,"title":3091},"\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":3093,"title":3094},"\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":3096,"title":3097},"\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":3099,"title":3100},"\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":3102,"title":3103},"\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":3105,"title":3106},"\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":3108,"title":3109},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain","Securing the Supply Chain of a Python CLI",{"path":3111,"title":3112},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpinning-dependencies-with-hashes","Pinning a Python CLI’s Dependencies with Hashes",{"path":3114,"title":3115},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpublishing-attestations-and-verifying-releases","Publishing Attestations and Verifying Python CLI Releases",{"path":3117,"title":3118},"\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":3120,"title":3121},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":3123,"title":3124},"\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":3126,"title":3127},"\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":3129,"title":3130},"\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":3132,"title":3133},"\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":3135,"title":3136},"\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":3138,"title":3139},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":3141,"title":3142},"\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":3144,"title":3145},"\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":3147,"title":3148},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":3150,"title":3151},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fisolating-cli-tools-from-project-dependencies","Isolating CLI Tools from Your Project’s Dependencies",{"path":3153,"title":3154},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":3156,"title":3157},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":3159,"title":3160},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1790967540159]