[{"data":1,"prerenderedAt":3854},["ShallowReactive",2],{"page-\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fwriting-a-config-init-and-edit-command\u002F":3,"content-directory":3010},{"id":4,"title":5,"body":6,"date":2996,"description":2997,"difficulty":2998,"draft":2999,"extension":3000,"meta":3001,"navigation":173,"path":3002,"seo":3003,"stem":3004,"tags":3005,"updated":2996,"__hash__":3009},"content\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fwriting-a-config-init-and-edit-command\u002Findex.md","Writing a Config Init and Edit Command for a Python CLI",{"type":7,"value":8,"toc":2972},"minimark",[9,58,63,80,84,88,128,132,1874,1888,1893,1898,1925,1929,1975,1993,1996,2000,2020,2028,2065,2077,2080,2084,2157,2161,2173,2803,2813,2817,2845,2849,2856,2859,2863,2875,2882,2885,2893,2916,2923,2935,2939,2968],[10,11,12,13,17,18,21,22,25,26,29,30,33,34,38,39,42,43,46,47,51,52,57],"p",{},"A configuration file nobody can find is a configuration file nobody uses. Most CLIs document their settings in a README section that users skim once, then guess at the file’s location, its format and the exact spelling of each key. Tools such as git, gh, npm and poetry solved this with a small family of subcommands: ",[14,15,16],"code",{},"config path"," tells you where the file lives, ",[14,19,20],{},"config init"," writes a commented starter file, ",[14,23,24],{},"config edit"," opens it in your editor, and ",[14,27,28],{},"config get","\u002F",[14,31,32],{},"config set"," read and change single values from scripts. This guide builds that family for a Typer CLI with TOML configuration. The interesting parts are not the commands themselves but three details that make them pleasant: the starter file is ",[35,36,37],"em",{},"commented",", so it documents itself; ",[14,40,41],{},"edit"," validates the file after the editor closes and offers to reopen it; and ",[14,44,45],{},"set"," uses ",[48,49,50],"strong",{},"tomlkit"," so that changing one value keeps every comment and the user’s own formatting intact. It belongs to the ",[53,54,56],"a",{"href":55},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002F","configuration files and environment variables topic",".",[59,60,62],"h2",{"id":61},"prerequisites","Prerequisites",[64,65,66,74],"ul",{},[67,68,69,70,57],"li",{},"A CLI that reads TOML configuration, as in ",[53,71,73],{"href":72},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib\u002F","reading TOML config with tomllib",[67,75,76,79],{},[14,77,78],{},"uv add typer tomlkit platformdirs"," (examples checked with Typer 0.27, tomlkit 0.15 and Python 3.13).",[59,81,83],{"id":82},"the-command-family","The command family",[85,86],"inline-diagram",{"name":87},"cfgcmd-family",[10,89,90,91,94,95,98,99,94,102,105,106,94,109,98,111,94,114,98,116,94,119,122,123,127],{},"Each subcommand answers one question a user actually has. ",[35,92,93],{},"Where is it?"," — ",[14,96,97],{},"path",". ",[35,100,101],{},"What can I put in it?",[14,103,104],{},"init",", which writes every supported key with a comment explaining it. ",[35,107,108],{},"How do I change it comfortably?",[14,110,41],{},[35,112,113],{},"How do I change it from a script or a setup guide?",[14,115,45],{},[35,117,118],{},"What is the current value?",[14,120,121],{},"get",". Reading the file at runtime, merging it with flags and environment variables, stays where it was: in the loading code described in ",[53,124,126],{"href":125},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults\u002F","config precedence: flags, env, files and defaults",". These commands only manage the file.",[59,129,131],{"id":130},"the-recipe","The recipe",[133,134,139],"pre",{"className":135,"code":136,"language":137,"meta":138,"style":138},"language-python shiki shiki-themes github-light github-dark","# src\u002Fmytool\u002Fconfig_cmd.py\nfrom __future__ import annotations\n\nimport os\nimport shlex\nimport subprocess\nimport sys\nimport tomllib\nfrom pathlib import Path\nfrom typing import Annotated\n\nimport tomlkit\nimport typer\nfrom platformdirs import user_config_path\n\nTEMPLATE = \"\"\"\\\n# mytool configuration — see `mytool config --help`.\n# Command-line options and MYTOOL_* environment variables override these values.\n\n[api]\n# Base URL of the API.\nurl = \"https:\u002F\u002Fapi.example.com\"\n# Seconds to wait for a response.\ntimeout = 30\n\n[output]\n# table, json or csv\nformat = \"table\"\n\"\"\"\n\napp = typer.Typer(help=\"Create, inspect and edit the configuration file.\")\n\n\ndef config_path() -> Path:\n    return Path(os.environ.get(\"MYTOOL_CONFIG\") or user_config_path(\"mytool\") \u002F \"config.toml\")\n\n\ndef validate(text: str) -> list[str]:\n    try:\n        data = tomllib.loads(text)\n    except tomllib.TOMLDecodeError as exc:\n        return [f\"not valid TOML: {exc}\"]\n    problems = []\n    timeout = data.get(\"api\", {}).get(\"timeout\", 30)\n    if not isinstance(timeout, (int, float)) or timeout \u003C= 0:\n        problems.append(\"api.timeout must be a positive number\")\n    if data.get(\"output\", {}).get(\"format\", \"table\") not in (\"table\", \"json\", \"csv\"):\n        problems.append(\"output.format must be table, json or csv\")\n    return problems\n\n\ndef _write_atomic(path: Path, text: str) -> None:\n    path.parent.mkdir(parents=True, exist_ok=True)\n    tmp = path.with_name(f\".{path.name}.tmp\")\n    tmp.write_text(text, encoding=\"utf-8\")\n    os.replace(tmp, path)\n\n\n@app.command()\ndef init(force: Annotated[bool, typer.Option(\"--force\", help=\"Overwrite an existing file.\")] = False) -> None:\n    \"\"\"Write a commented starter configuration.\"\"\"\n    path = config_path()\n    if path.exists() and not force:\n        typer.echo(f\"error: {path} already exists (use --force to overwrite)\", err=True)\n        raise typer.Exit(1)\n    _write_atomic(path, TEMPLATE)\n    typer.echo(f\"wrote {path}\", err=True)\n\n\n@app.command()\ndef path() -> None:\n    \"\"\"Print the configuration file path.\"\"\"\n    typer.echo(config_path())\n\n\ndef _editor() -> list[str]:\n    editor = os.environ.get(\"VISUAL\") or os.environ.get(\"EDITOR\") or (\"notepad\" if os.name == \"nt\" else \"vi\")\n    return shlex.split(editor, posix=os.name != \"nt\")\n\n\n@app.command()\ndef edit() -> None:\n    \"\"\"Open the configuration in $VISUAL or $EDITOR and validate it afterwards.\"\"\"\n    path = config_path()\n    if not path.exists():\n        _write_atomic(path, TEMPLATE)\n    while True:\n        subprocess.run([*_editor(), str(path)], check=False)\n        problems = validate(path.read_text(encoding=\"utf-8\"))\n        if not problems:\n            typer.echo(f\"saved {path}\", err=True)\n            return\n        for problem in problems:\n            typer.echo(f\"error: {problem}\", err=True)\n        if not sys.stdin.isatty() or not typer.confirm(\"Edit again?\", default=True, err=True):\n            raise typer.Exit(1)\n\n\ndef _parse_value(raw: str):\n    try:\n        return tomllib.loads(f\"v = {raw}\")[\"v\"]      # numbers, booleans, quoted strings, arrays\n    except tomllib.TOMLDecodeError:\n        return raw                                    # anything else is a bare string\n\n\n@app.command(\"set\")\ndef set_value(key: str, value: str) -> None:\n    \"\"\"Set a dotted KEY (for example api.timeout) to VALUE, keeping comments.\"\"\"\n    path = config_path()\n    doc = tomlkit.parse(path.read_text(encoding=\"utf-8\")) if path.exists() else tomlkit.document()\n    *tables, leaf = key.split(\".\")\n    node = doc\n    for name in tables:\n        node = node.setdefault(name, tomlkit.table())\n    node[leaf] = _parse_value(value)\n    text = tomlkit.dumps(doc)\n    if problems := validate(text):\n        typer.echo(\"error: \" + \"; \".join(problems), err=True)\n        raise typer.Exit(1)\n    _write_atomic(path, text)\n\n\n@app.command(\"get\")\ndef get_value(key: str) -> None:\n    \"\"\"Print the value of a dotted KEY.\"\"\"\n    node = tomllib.loads(config_path().read_text(encoding=\"utf-8\"))\n    for part in key.split(\".\"):\n        if not isinstance(node, dict) or part not in node:\n            typer.echo(f\"error: {key} is not set\", err=True)\n            raise typer.Exit(1)\n        node = node[part]\n    typer.echo(node)\n","python","",[14,140,141,150,168,175,184,192,200,208,216,229,242,247,255,263,276,281,297,303,309,314,320,326,332,338,344,349,355,361,367,373,378,402,407,412,425,458,463,468,490,499,510,525,555,566,594,633,644,690,700,708,713,718,739,764,792,808,814,819,824,833,876,882,893,909,940,954,964,993,998,1003,1010,1025,1031,1037,1042,1047,1062,1114,1137,1142,1147,1154,1168,1174,1183,1193,1203,1214,1241,1261,1272,1301,1307,1321,1349,1388,1400,1405,1410,1425,1432,1466,1474,1485,1490,1495,1508,1532,1538,1547,1577,1596,1607,1621,1632,1643,1654,1668,1693,1704,1710,1715,1720,1732,1750,1756,1774,1790,1818,1847,1858,1868],{"__ignoreMap":138},[142,143,146],"span",{"class":144,"line":145},"line",1,[142,147,149],{"class":148},"sJ8bj","# src\u002Fmytool\u002Fconfig_cmd.py\n",[142,151,153,157,161,164],{"class":144,"line":152},2,[142,154,156],{"class":155},"szBVR","from",[142,158,160],{"class":159},"sj4cs"," __future__",[142,162,163],{"class":155}," import",[142,165,167],{"class":166},"sVt8B"," annotations\n",[142,169,171],{"class":144,"line":170},3,[142,172,174],{"emptyLinePlaceholder":173},true,"\n",[142,176,178,181],{"class":144,"line":177},4,[142,179,180],{"class":155},"import",[142,182,183],{"class":166}," os\n",[142,185,187,189],{"class":144,"line":186},5,[142,188,180],{"class":155},[142,190,191],{"class":166}," shlex\n",[142,193,195,197],{"class":144,"line":194},6,[142,196,180],{"class":155},[142,198,199],{"class":166}," subprocess\n",[142,201,203,205],{"class":144,"line":202},7,[142,204,180],{"class":155},[142,206,207],{"class":166}," sys\n",[142,209,211,213],{"class":144,"line":210},8,[142,212,180],{"class":155},[142,214,215],{"class":166}," tomllib\n",[142,217,219,221,224,226],{"class":144,"line":218},9,[142,220,156],{"class":155},[142,222,223],{"class":166}," pathlib ",[142,225,180],{"class":155},[142,227,228],{"class":166}," Path\n",[142,230,232,234,237,239],{"class":144,"line":231},10,[142,233,156],{"class":155},[142,235,236],{"class":166}," typing ",[142,238,180],{"class":155},[142,240,241],{"class":166}," Annotated\n",[142,243,245],{"class":144,"line":244},11,[142,246,174],{"emptyLinePlaceholder":173},[142,248,250,252],{"class":144,"line":249},12,[142,251,180],{"class":155},[142,253,254],{"class":166}," tomlkit\n",[142,256,258,260],{"class":144,"line":257},13,[142,259,180],{"class":155},[142,261,262],{"class":166}," typer\n",[142,264,266,268,271,273],{"class":144,"line":265},14,[142,267,156],{"class":155},[142,269,270],{"class":166}," platformdirs ",[142,272,180],{"class":155},[142,274,275],{"class":166}," user_config_path\n",[142,277,279],{"class":144,"line":278},15,[142,280,174],{"emptyLinePlaceholder":173},[142,282,284,287,290,294],{"class":144,"line":283},16,[142,285,286],{"class":159},"TEMPLATE",[142,288,289],{"class":155}," =",[142,291,293],{"class":292},"sZZnC"," \"\"\"",[142,295,296],{"class":159},"\\\n",[142,298,300],{"class":144,"line":299},17,[142,301,302],{"class":292},"# mytool configuration — see `mytool config --help`.\n",[142,304,306],{"class":144,"line":305},18,[142,307,308],{"class":292},"# Command-line options and MYTOOL_* environment variables override these values.\n",[142,310,312],{"class":144,"line":311},19,[142,313,174],{"emptyLinePlaceholder":173},[142,315,317],{"class":144,"line":316},20,[142,318,319],{"class":292},"[api]\n",[142,321,323],{"class":144,"line":322},21,[142,324,325],{"class":292},"# Base URL of the API.\n",[142,327,329],{"class":144,"line":328},22,[142,330,331],{"class":292},"url = \"https:\u002F\u002Fapi.example.com\"\n",[142,333,335],{"class":144,"line":334},23,[142,336,337],{"class":292},"# Seconds to wait for a response.\n",[142,339,341],{"class":144,"line":340},24,[142,342,343],{"class":292},"timeout = 30\n",[142,345,347],{"class":144,"line":346},25,[142,348,174],{"emptyLinePlaceholder":173},[142,350,352],{"class":144,"line":351},26,[142,353,354],{"class":292},"[output]\n",[142,356,358],{"class":144,"line":357},27,[142,359,360],{"class":292},"# table, json or csv\n",[142,362,364],{"class":144,"line":363},28,[142,365,366],{"class":292},"format = \"table\"\n",[142,368,370],{"class":144,"line":369},29,[142,371,372],{"class":292},"\"\"\"\n",[142,374,376],{"class":144,"line":375},30,[142,377,174],{"emptyLinePlaceholder":173},[142,379,381,384,387,390,394,396,399],{"class":144,"line":380},31,[142,382,383],{"class":166},"app ",[142,385,386],{"class":155},"=",[142,388,389],{"class":166}," typer.Typer(",[142,391,393],{"class":392},"s4XuR","help",[142,395,386],{"class":155},[142,397,398],{"class":292},"\"Create, inspect and edit the configuration file.\"",[142,400,401],{"class":166},")\n",[142,403,405],{"class":144,"line":404},32,[142,406,174],{"emptyLinePlaceholder":173},[142,408,410],{"class":144,"line":409},33,[142,411,174],{"emptyLinePlaceholder":173},[142,413,415,418,422],{"class":144,"line":414},34,[142,416,417],{"class":155},"def",[142,419,421],{"class":420},"sScJk"," config_path",[142,423,424],{"class":166},"() -> Path:\n",[142,426,428,431,434,437,440,443,446,449,451,453,456],{"class":144,"line":427},35,[142,429,430],{"class":155},"    return",[142,432,433],{"class":166}," Path(os.environ.get(",[142,435,436],{"class":292},"\"MYTOOL_CONFIG\"",[142,438,439],{"class":166},") ",[142,441,442],{"class":155},"or",[142,444,445],{"class":166}," user_config_path(",[142,447,448],{"class":292},"\"mytool\"",[142,450,439],{"class":166},[142,452,29],{"class":155},[142,454,455],{"class":292}," \"config.toml\"",[142,457,401],{"class":166},[142,459,461],{"class":144,"line":460},36,[142,462,174],{"emptyLinePlaceholder":173},[142,464,466],{"class":144,"line":465},37,[142,467,174],{"emptyLinePlaceholder":173},[142,469,471,473,476,479,482,485,487],{"class":144,"line":470},38,[142,472,417],{"class":155},[142,474,475],{"class":420}," validate",[142,477,478],{"class":166},"(text: ",[142,480,481],{"class":159},"str",[142,483,484],{"class":166},") -> list[",[142,486,481],{"class":159},[142,488,489],{"class":166},"]:\n",[142,491,493,496],{"class":144,"line":492},39,[142,494,495],{"class":155},"    try",[142,497,498],{"class":166},":\n",[142,500,502,505,507],{"class":144,"line":501},40,[142,503,504],{"class":166},"        data ",[142,506,386],{"class":155},[142,508,509],{"class":166}," tomllib.loads(text)\n",[142,511,513,516,519,522],{"class":144,"line":512},41,[142,514,515],{"class":155},"    except",[142,517,518],{"class":166}," tomllib.TOMLDecodeError ",[142,520,521],{"class":155},"as",[142,523,524],{"class":166}," exc:\n",[142,526,528,531,534,537,540,543,546,549,552],{"class":144,"line":527},42,[142,529,530],{"class":155},"        return",[142,532,533],{"class":166}," [",[142,535,536],{"class":155},"f",[142,538,539],{"class":292},"\"not valid TOML: ",[142,541,542],{"class":159},"{",[142,544,545],{"class":166},"exc",[142,547,548],{"class":159},"}",[142,550,551],{"class":292},"\"",[142,553,554],{"class":166},"]\n",[142,556,558,561,563],{"class":144,"line":557},43,[142,559,560],{"class":166},"    problems ",[142,562,386],{"class":155},[142,564,565],{"class":166}," []\n",[142,567,569,572,574,577,580,583,586,589,592],{"class":144,"line":568},44,[142,570,571],{"class":166},"    timeout ",[142,573,386],{"class":155},[142,575,576],{"class":166}," data.get(",[142,578,579],{"class":292},"\"api\"",[142,581,582],{"class":166},", {}).get(",[142,584,585],{"class":292},"\"timeout\"",[142,587,588],{"class":166},", ",[142,590,591],{"class":159},"30",[142,593,401],{"class":166},[142,595,597,600,603,606,609,612,614,617,620,622,625,628,631],{"class":144,"line":596},45,[142,598,599],{"class":155},"    if",[142,601,602],{"class":155}," not",[142,604,605],{"class":159}," isinstance",[142,607,608],{"class":166},"(timeout, (",[142,610,611],{"class":159},"int",[142,613,588],{"class":166},[142,615,616],{"class":159},"float",[142,618,619],{"class":166},")) ",[142,621,442],{"class":155},[142,623,624],{"class":166}," timeout ",[142,626,627],{"class":155},"\u003C=",[142,629,630],{"class":159}," 0",[142,632,498],{"class":166},[142,634,636,639,642],{"class":144,"line":635},46,[142,637,638],{"class":166},"        problems.append(",[142,640,641],{"class":292},"\"api.timeout must be a positive number\"",[142,643,401],{"class":166},[142,645,647,649,651,654,656,659,661,664,666,669,672,675,677,679,682,684,687],{"class":144,"line":646},47,[142,648,599],{"class":155},[142,650,576],{"class":166},[142,652,653],{"class":292},"\"output\"",[142,655,582],{"class":166},[142,657,658],{"class":292},"\"format\"",[142,660,588],{"class":166},[142,662,663],{"class":292},"\"table\"",[142,665,439],{"class":166},[142,667,668],{"class":155},"not",[142,670,671],{"class":155}," in",[142,673,674],{"class":166}," (",[142,676,663],{"class":292},[142,678,588],{"class":166},[142,680,681],{"class":292},"\"json\"",[142,683,588],{"class":166},[142,685,686],{"class":292},"\"csv\"",[142,688,689],{"class":166},"):\n",[142,691,693,695,698],{"class":144,"line":692},48,[142,694,638],{"class":166},[142,696,697],{"class":292},"\"output.format must be table, json or csv\"",[142,699,401],{"class":166},[142,701,703,705],{"class":144,"line":702},49,[142,704,430],{"class":155},[142,706,707],{"class":166}," problems\n",[142,709,711],{"class":144,"line":710},50,[142,712,174],{"emptyLinePlaceholder":173},[142,714,716],{"class":144,"line":715},51,[142,717,174],{"emptyLinePlaceholder":173},[142,719,721,723,726,729,731,734,737],{"class":144,"line":720},52,[142,722,417],{"class":155},[142,724,725],{"class":420}," _write_atomic",[142,727,728],{"class":166},"(path: Path, text: ",[142,730,481],{"class":159},[142,732,733],{"class":166},") -> ",[142,735,736],{"class":159},"None",[142,738,498],{"class":166},[142,740,742,745,748,750,753,755,758,760,762],{"class":144,"line":741},53,[142,743,744],{"class":166},"    path.parent.mkdir(",[142,746,747],{"class":392},"parents",[142,749,386],{"class":155},[142,751,752],{"class":159},"True",[142,754,588],{"class":166},[142,756,757],{"class":392},"exist_ok",[142,759,386],{"class":155},[142,761,752],{"class":159},[142,763,401],{"class":166},[142,765,767,770,772,775,777,780,782,785,787,790],{"class":144,"line":766},54,[142,768,769],{"class":166},"    tmp ",[142,771,386],{"class":155},[142,773,774],{"class":166}," path.with_name(",[142,776,536],{"class":155},[142,778,779],{"class":292},"\".",[142,781,542],{"class":159},[142,783,784],{"class":166},"path.name",[142,786,548],{"class":159},[142,788,789],{"class":292},".tmp\"",[142,791,401],{"class":166},[142,793,795,798,801,803,806],{"class":144,"line":794},55,[142,796,797],{"class":166},"    tmp.write_text(text, ",[142,799,800],{"class":392},"encoding",[142,802,386],{"class":155},[142,804,805],{"class":292},"\"utf-8\"",[142,807,401],{"class":166},[142,809,811],{"class":144,"line":810},56,[142,812,813],{"class":166},"    os.replace(tmp, path)\n",[142,815,817],{"class":144,"line":816},57,[142,818,174],{"emptyLinePlaceholder":173},[142,820,822],{"class":144,"line":821},58,[142,823,174],{"emptyLinePlaceholder":173},[142,825,827,830],{"class":144,"line":826},59,[142,828,829],{"class":420},"@app.command",[142,831,832],{"class":166},"()\n",[142,834,836,838,841,844,847,850,853,855,857,859,862,865,867,870,872,874],{"class":144,"line":835},60,[142,837,417],{"class":155},[142,839,840],{"class":420}," init",[142,842,843],{"class":166},"(force: Annotated[",[142,845,846],{"class":159},"bool",[142,848,849],{"class":166},", typer.Option(",[142,851,852],{"class":292},"\"--force\"",[142,854,588],{"class":166},[142,856,393],{"class":392},[142,858,386],{"class":155},[142,860,861],{"class":292},"\"Overwrite an existing file.\"",[142,863,864],{"class":166},")] ",[142,866,386],{"class":155},[142,868,869],{"class":159}," False",[142,871,733],{"class":166},[142,873,736],{"class":159},[142,875,498],{"class":166},[142,877,879],{"class":144,"line":878},61,[142,880,881],{"class":292},"    \"\"\"Write a commented starter configuration.\"\"\"\n",[142,883,885,888,890],{"class":144,"line":884},62,[142,886,887],{"class":166},"    path ",[142,889,386],{"class":155},[142,891,892],{"class":166}," config_path()\n",[142,894,896,898,901,904,906],{"class":144,"line":895},63,[142,897,599],{"class":155},[142,899,900],{"class":166}," path.exists() ",[142,902,903],{"class":155},"and",[142,905,602],{"class":155},[142,907,908],{"class":166}," force:\n",[142,910,912,915,917,920,922,924,926,929,931,934,936,938],{"class":144,"line":911},64,[142,913,914],{"class":166},"        typer.echo(",[142,916,536],{"class":155},[142,918,919],{"class":292},"\"error: ",[142,921,542],{"class":159},[142,923,97],{"class":166},[142,925,548],{"class":159},[142,927,928],{"class":292}," already exists (use --force to overwrite)\"",[142,930,588],{"class":166},[142,932,933],{"class":392},"err",[142,935,386],{"class":155},[142,937,752],{"class":159},[142,939,401],{"class":166},[142,941,943,946,949,952],{"class":144,"line":942},65,[142,944,945],{"class":155},"        raise",[142,947,948],{"class":166}," typer.Exit(",[142,950,951],{"class":159},"1",[142,953,401],{"class":166},[142,955,957,960,962],{"class":144,"line":956},66,[142,958,959],{"class":166},"    _write_atomic(path, ",[142,961,286],{"class":159},[142,963,401],{"class":166},[142,965,967,970,972,975,977,979,981,983,985,987,989,991],{"class":144,"line":966},67,[142,968,969],{"class":166},"    typer.echo(",[142,971,536],{"class":155},[142,973,974],{"class":292},"\"wrote ",[142,976,542],{"class":159},[142,978,97],{"class":166},[142,980,548],{"class":159},[142,982,551],{"class":292},[142,984,588],{"class":166},[142,986,933],{"class":392},[142,988,386],{"class":155},[142,990,752],{"class":159},[142,992,401],{"class":166},[142,994,996],{"class":144,"line":995},68,[142,997,174],{"emptyLinePlaceholder":173},[142,999,1001],{"class":144,"line":1000},69,[142,1002,174],{"emptyLinePlaceholder":173},[142,1004,1006,1008],{"class":144,"line":1005},70,[142,1007,829],{"class":420},[142,1009,832],{"class":166},[142,1011,1013,1015,1018,1021,1023],{"class":144,"line":1012},71,[142,1014,417],{"class":155},[142,1016,1017],{"class":420}," path",[142,1019,1020],{"class":166},"() -> ",[142,1022,736],{"class":159},[142,1024,498],{"class":166},[142,1026,1028],{"class":144,"line":1027},72,[142,1029,1030],{"class":292},"    \"\"\"Print the configuration file path.\"\"\"\n",[142,1032,1034],{"class":144,"line":1033},73,[142,1035,1036],{"class":166},"    typer.echo(config_path())\n",[142,1038,1040],{"class":144,"line":1039},74,[142,1041,174],{"emptyLinePlaceholder":173},[142,1043,1045],{"class":144,"line":1044},75,[142,1046,174],{"emptyLinePlaceholder":173},[142,1048,1050,1052,1055,1058,1060],{"class":144,"line":1049},76,[142,1051,417],{"class":155},[142,1053,1054],{"class":420}," _editor",[142,1056,1057],{"class":166},"() -> list[",[142,1059,481],{"class":159},[142,1061,489],{"class":166},[142,1063,1065,1068,1070,1073,1076,1078,1080,1082,1085,1087,1089,1091,1094,1097,1100,1103,1106,1109,1112],{"class":144,"line":1064},77,[142,1066,1067],{"class":166},"    editor ",[142,1069,386],{"class":155},[142,1071,1072],{"class":166}," os.environ.get(",[142,1074,1075],{"class":292},"\"VISUAL\"",[142,1077,439],{"class":166},[142,1079,442],{"class":155},[142,1081,1072],{"class":166},[142,1083,1084],{"class":292},"\"EDITOR\"",[142,1086,439],{"class":166},[142,1088,442],{"class":155},[142,1090,674],{"class":166},[142,1092,1093],{"class":292},"\"notepad\"",[142,1095,1096],{"class":155}," if",[142,1098,1099],{"class":166}," os.name ",[142,1101,1102],{"class":155},"==",[142,1104,1105],{"class":292}," \"nt\"",[142,1107,1108],{"class":155}," else",[142,1110,1111],{"class":292}," \"vi\"",[142,1113,401],{"class":166},[142,1115,1117,1119,1122,1125,1127,1130,1133,1135],{"class":144,"line":1116},78,[142,1118,430],{"class":155},[142,1120,1121],{"class":166}," shlex.split(editor, ",[142,1123,1124],{"class":392},"posix",[142,1126,386],{"class":155},[142,1128,1129],{"class":166},"os.name ",[142,1131,1132],{"class":155},"!=",[142,1134,1105],{"class":292},[142,1136,401],{"class":166},[142,1138,1140],{"class":144,"line":1139},79,[142,1141,174],{"emptyLinePlaceholder":173},[142,1143,1145],{"class":144,"line":1144},80,[142,1146,174],{"emptyLinePlaceholder":173},[142,1148,1150,1152],{"class":144,"line":1149},81,[142,1151,829],{"class":420},[142,1153,832],{"class":166},[142,1155,1157,1159,1162,1164,1166],{"class":144,"line":1156},82,[142,1158,417],{"class":155},[142,1160,1161],{"class":420}," edit",[142,1163,1020],{"class":166},[142,1165,736],{"class":159},[142,1167,498],{"class":166},[142,1169,1171],{"class":144,"line":1170},83,[142,1172,1173],{"class":292},"    \"\"\"Open the configuration in $VISUAL or $EDITOR and validate it afterwards.\"\"\"\n",[142,1175,1177,1179,1181],{"class":144,"line":1176},84,[142,1178,887],{"class":166},[142,1180,386],{"class":155},[142,1182,892],{"class":166},[142,1184,1186,1188,1190],{"class":144,"line":1185},85,[142,1187,599],{"class":155},[142,1189,602],{"class":155},[142,1191,1192],{"class":166}," path.exists():\n",[142,1194,1196,1199,1201],{"class":144,"line":1195},86,[142,1197,1198],{"class":166},"        _write_atomic(path, ",[142,1200,286],{"class":159},[142,1202,401],{"class":166},[142,1204,1206,1209,1212],{"class":144,"line":1205},87,[142,1207,1208],{"class":155},"    while",[142,1210,1211],{"class":159}," True",[142,1213,498],{"class":166},[142,1215,1217,1220,1223,1226,1228,1231,1234,1236,1239],{"class":144,"line":1216},88,[142,1218,1219],{"class":166},"        subprocess.run([",[142,1221,1222],{"class":155},"*",[142,1224,1225],{"class":166},"_editor(), ",[142,1227,481],{"class":159},[142,1229,1230],{"class":166},"(path)], ",[142,1232,1233],{"class":392},"check",[142,1235,386],{"class":155},[142,1237,1238],{"class":159},"False",[142,1240,401],{"class":166},[142,1242,1244,1247,1249,1252,1254,1256,1258],{"class":144,"line":1243},89,[142,1245,1246],{"class":166},"        problems ",[142,1248,386],{"class":155},[142,1250,1251],{"class":166}," validate(path.read_text(",[142,1253,800],{"class":392},[142,1255,386],{"class":155},[142,1257,805],{"class":292},[142,1259,1260],{"class":166},"))\n",[142,1262,1264,1267,1269],{"class":144,"line":1263},90,[142,1265,1266],{"class":155},"        if",[142,1268,602],{"class":155},[142,1270,1271],{"class":166}," problems:\n",[142,1273,1275,1278,1280,1283,1285,1287,1289,1291,1293,1295,1297,1299],{"class":144,"line":1274},91,[142,1276,1277],{"class":166},"            typer.echo(",[142,1279,536],{"class":155},[142,1281,1282],{"class":292},"\"saved ",[142,1284,542],{"class":159},[142,1286,97],{"class":166},[142,1288,548],{"class":159},[142,1290,551],{"class":292},[142,1292,588],{"class":166},[142,1294,933],{"class":392},[142,1296,386],{"class":155},[142,1298,752],{"class":159},[142,1300,401],{"class":166},[142,1302,1304],{"class":144,"line":1303},92,[142,1305,1306],{"class":155},"            return\n",[142,1308,1310,1313,1316,1319],{"class":144,"line":1309},93,[142,1311,1312],{"class":155},"        for",[142,1314,1315],{"class":166}," problem ",[142,1317,1318],{"class":155},"in",[142,1320,1271],{"class":166},[142,1322,1324,1326,1328,1330,1332,1335,1337,1339,1341,1343,1345,1347],{"class":144,"line":1323},94,[142,1325,1277],{"class":166},[142,1327,536],{"class":155},[142,1329,919],{"class":292},[142,1331,542],{"class":159},[142,1333,1334],{"class":166},"problem",[142,1336,548],{"class":159},[142,1338,551],{"class":292},[142,1340,588],{"class":166},[142,1342,933],{"class":392},[142,1344,386],{"class":155},[142,1346,752],{"class":159},[142,1348,401],{"class":166},[142,1350,1352,1354,1356,1359,1361,1363,1366,1369,1371,1374,1376,1378,1380,1382,1384,1386],{"class":144,"line":1351},95,[142,1353,1266],{"class":155},[142,1355,602],{"class":155},[142,1357,1358],{"class":166}," sys.stdin.isatty() ",[142,1360,442],{"class":155},[142,1362,602],{"class":155},[142,1364,1365],{"class":166}," typer.confirm(",[142,1367,1368],{"class":292},"\"Edit again?\"",[142,1370,588],{"class":166},[142,1372,1373],{"class":392},"default",[142,1375,386],{"class":155},[142,1377,752],{"class":159},[142,1379,588],{"class":166},[142,1381,933],{"class":392},[142,1383,386],{"class":155},[142,1385,752],{"class":159},[142,1387,689],{"class":166},[142,1389,1391,1394,1396,1398],{"class":144,"line":1390},96,[142,1392,1393],{"class":155},"            raise",[142,1395,948],{"class":166},[142,1397,951],{"class":159},[142,1399,401],{"class":166},[142,1401,1403],{"class":144,"line":1402},97,[142,1404,174],{"emptyLinePlaceholder":173},[142,1406,1408],{"class":144,"line":1407},98,[142,1409,174],{"emptyLinePlaceholder":173},[142,1411,1413,1415,1418,1421,1423],{"class":144,"line":1412},99,[142,1414,417],{"class":155},[142,1416,1417],{"class":420}," _parse_value",[142,1419,1420],{"class":166},"(raw: ",[142,1422,481],{"class":159},[142,1424,689],{"class":166},[142,1426,1428,1430],{"class":144,"line":1427},100,[142,1429,495],{"class":155},[142,1431,498],{"class":166},[142,1433,1435,1437,1440,1442,1445,1447,1450,1452,1454,1457,1460,1463],{"class":144,"line":1434},101,[142,1436,530],{"class":155},[142,1438,1439],{"class":166}," tomllib.loads(",[142,1441,536],{"class":155},[142,1443,1444],{"class":292},"\"v = ",[142,1446,542],{"class":159},[142,1448,1449],{"class":166},"raw",[142,1451,548],{"class":159},[142,1453,551],{"class":292},[142,1455,1456],{"class":166},")[",[142,1458,1459],{"class":292},"\"v\"",[142,1461,1462],{"class":166},"]      ",[142,1464,1465],{"class":148},"# numbers, booleans, quoted strings, arrays\n",[142,1467,1469,1471],{"class":144,"line":1468},102,[142,1470,515],{"class":155},[142,1472,1473],{"class":166}," tomllib.TOMLDecodeError:\n",[142,1475,1477,1479,1482],{"class":144,"line":1476},103,[142,1478,530],{"class":155},[142,1480,1481],{"class":166}," raw                                    ",[142,1483,1484],{"class":148},"# anything else is a bare string\n",[142,1486,1488],{"class":144,"line":1487},104,[142,1489,174],{"emptyLinePlaceholder":173},[142,1491,1493],{"class":144,"line":1492},105,[142,1494,174],{"emptyLinePlaceholder":173},[142,1496,1498,1500,1503,1506],{"class":144,"line":1497},106,[142,1499,829],{"class":420},[142,1501,1502],{"class":166},"(",[142,1504,1505],{"class":292},"\"set\"",[142,1507,401],{"class":166},[142,1509,1511,1513,1516,1519,1521,1524,1526,1528,1530],{"class":144,"line":1510},107,[142,1512,417],{"class":155},[142,1514,1515],{"class":420}," set_value",[142,1517,1518],{"class":166},"(key: ",[142,1520,481],{"class":159},[142,1522,1523],{"class":166},", value: ",[142,1525,481],{"class":159},[142,1527,733],{"class":166},[142,1529,736],{"class":159},[142,1531,498],{"class":166},[142,1533,1535],{"class":144,"line":1534},108,[142,1536,1537],{"class":292},"    \"\"\"Set a dotted KEY (for example api.timeout) to VALUE, keeping comments.\"\"\"\n",[142,1539,1541,1543,1545],{"class":144,"line":1540},109,[142,1542,887],{"class":166},[142,1544,386],{"class":155},[142,1546,892],{"class":166},[142,1548,1550,1553,1555,1558,1560,1562,1564,1566,1569,1571,1574],{"class":144,"line":1549},110,[142,1551,1552],{"class":166},"    doc ",[142,1554,386],{"class":155},[142,1556,1557],{"class":166}," tomlkit.parse(path.read_text(",[142,1559,800],{"class":392},[142,1561,386],{"class":155},[142,1563,805],{"class":292},[142,1565,619],{"class":166},[142,1567,1568],{"class":155},"if",[142,1570,900],{"class":166},[142,1572,1573],{"class":155},"else",[142,1575,1576],{"class":166}," tomlkit.document()\n",[142,1578,1580,1583,1586,1588,1591,1594],{"class":144,"line":1579},111,[142,1581,1582],{"class":155},"    *",[142,1584,1585],{"class":166},"tables, leaf ",[142,1587,386],{"class":155},[142,1589,1590],{"class":166}," key.split(",[142,1592,1593],{"class":292},"\".\"",[142,1595,401],{"class":166},[142,1597,1599,1602,1604],{"class":144,"line":1598},112,[142,1600,1601],{"class":166},"    node ",[142,1603,386],{"class":155},[142,1605,1606],{"class":166}," doc\n",[142,1608,1610,1613,1616,1618],{"class":144,"line":1609},113,[142,1611,1612],{"class":155},"    for",[142,1614,1615],{"class":166}," name ",[142,1617,1318],{"class":155},[142,1619,1620],{"class":166}," tables:\n",[142,1622,1624,1627,1629],{"class":144,"line":1623},114,[142,1625,1626],{"class":166},"        node ",[142,1628,386],{"class":155},[142,1630,1631],{"class":166}," node.setdefault(name, tomlkit.table())\n",[142,1633,1635,1638,1640],{"class":144,"line":1634},115,[142,1636,1637],{"class":166},"    node[leaf] ",[142,1639,386],{"class":155},[142,1641,1642],{"class":166}," _parse_value(value)\n",[142,1644,1646,1649,1651],{"class":144,"line":1645},116,[142,1647,1648],{"class":166},"    text ",[142,1650,386],{"class":155},[142,1652,1653],{"class":166}," tomlkit.dumps(doc)\n",[142,1655,1657,1659,1662,1665],{"class":144,"line":1656},117,[142,1658,599],{"class":155},[142,1660,1661],{"class":166}," problems ",[142,1663,1664],{"class":155},":=",[142,1666,1667],{"class":166}," validate(text):\n",[142,1669,1671,1673,1676,1679,1682,1685,1687,1689,1691],{"class":144,"line":1670},118,[142,1672,914],{"class":166},[142,1674,1675],{"class":292},"\"error: \"",[142,1677,1678],{"class":155}," +",[142,1680,1681],{"class":292}," \"; \"",[142,1683,1684],{"class":166},".join(problems), ",[142,1686,933],{"class":392},[142,1688,386],{"class":155},[142,1690,752],{"class":159},[142,1692,401],{"class":166},[142,1694,1696,1698,1700,1702],{"class":144,"line":1695},119,[142,1697,945],{"class":155},[142,1699,948],{"class":166},[142,1701,951],{"class":159},[142,1703,401],{"class":166},[142,1705,1707],{"class":144,"line":1706},120,[142,1708,1709],{"class":166},"    _write_atomic(path, text)\n",[142,1711,1713],{"class":144,"line":1712},121,[142,1714,174],{"emptyLinePlaceholder":173},[142,1716,1718],{"class":144,"line":1717},122,[142,1719,174],{"emptyLinePlaceholder":173},[142,1721,1723,1725,1727,1730],{"class":144,"line":1722},123,[142,1724,829],{"class":420},[142,1726,1502],{"class":166},[142,1728,1729],{"class":292},"\"get\"",[142,1731,401],{"class":166},[142,1733,1735,1737,1740,1742,1744,1746,1748],{"class":144,"line":1734},124,[142,1736,417],{"class":155},[142,1738,1739],{"class":420}," get_value",[142,1741,1518],{"class":166},[142,1743,481],{"class":159},[142,1745,733],{"class":166},[142,1747,736],{"class":159},[142,1749,498],{"class":166},[142,1751,1753],{"class":144,"line":1752},125,[142,1754,1755],{"class":292},"    \"\"\"Print the value of a dotted KEY.\"\"\"\n",[142,1757,1759,1761,1763,1766,1768,1770,1772],{"class":144,"line":1758},126,[142,1760,1601],{"class":166},[142,1762,386],{"class":155},[142,1764,1765],{"class":166}," tomllib.loads(config_path().read_text(",[142,1767,800],{"class":392},[142,1769,386],{"class":155},[142,1771,805],{"class":292},[142,1773,1260],{"class":166},[142,1775,1777,1779,1782,1784,1786,1788],{"class":144,"line":1776},127,[142,1778,1612],{"class":155},[142,1780,1781],{"class":166}," part ",[142,1783,1318],{"class":155},[142,1785,1590],{"class":166},[142,1787,1593],{"class":292},[142,1789,689],{"class":166},[142,1791,1793,1795,1797,1799,1802,1805,1807,1809,1811,1813,1815],{"class":144,"line":1792},128,[142,1794,1266],{"class":155},[142,1796,602],{"class":155},[142,1798,605],{"class":159},[142,1800,1801],{"class":166},"(node, ",[142,1803,1804],{"class":159},"dict",[142,1806,439],{"class":166},[142,1808,442],{"class":155},[142,1810,1781],{"class":166},[142,1812,668],{"class":155},[142,1814,671],{"class":155},[142,1816,1817],{"class":166}," node:\n",[142,1819,1821,1823,1825,1827,1829,1832,1834,1837,1839,1841,1843,1845],{"class":144,"line":1820},129,[142,1822,1277],{"class":166},[142,1824,536],{"class":155},[142,1826,919],{"class":292},[142,1828,542],{"class":159},[142,1830,1831],{"class":166},"key",[142,1833,548],{"class":159},[142,1835,1836],{"class":292}," is not set\"",[142,1838,588],{"class":166},[142,1840,933],{"class":392},[142,1842,386],{"class":155},[142,1844,752],{"class":159},[142,1846,401],{"class":166},[142,1848,1850,1852,1854,1856],{"class":144,"line":1849},130,[142,1851,1393],{"class":155},[142,1853,948],{"class":166},[142,1855,951],{"class":159},[142,1857,401],{"class":166},[142,1859,1861,1863,1865],{"class":144,"line":1860},131,[142,1862,1626],{"class":166},[142,1864,386],{"class":155},[142,1866,1867],{"class":166}," node[part]\n",[142,1869,1871],{"class":144,"line":1870},132,[142,1872,1873],{"class":166},"    typer.echo(node)\n",[10,1875,1876,1877,1880,1881,588,1884,1887],{},"Mount it on the main app with ",[14,1878,1879],{},"app.add_typer(config_cmd.app, name=\"config\")",", and the five commands appear as ",[14,1882,1883],{},"mytool config init",[14,1885,1886],{},"mytool config edit"," and so on.",[1889,1890,1892],"h3",{"id":1891},"a-starter-file-that-documents-itself","A starter file that documents itself",[10,1894,1895,1897],{},[14,1896,104],{}," writes a template string rather than serialising a dictionary. That is deliberate: a dumped dictionary has no comments, while the template explains each key, names the allowed values and points at the override order. It is the first thing a user reads about your settings, so treat it as documentation — keep it in sync with the settings model, and test that it parses and passes validation (the first test below does exactly that, implicitly, by setting values afterwards).",[10,1899,1900,1902,1903,1906,1907,1909,1910,1912,1913,1916,1917,1920,1921,57],{},[14,1901,104],{}," refuses to overwrite an existing file without ",[14,1904,1905],{},"--force",". Overwriting someone’s carefully tuned configuration because they ran a setup command twice is the kind of mistake users remember. Both ",[14,1908,104],{}," and ",[14,1911,45],{}," write through ",[14,1914,1915],{},"_write_atomic",": the new content goes to a temporary file in the same directory, then ",[14,1918,1919],{},"os.replace"," swaps it in, so an interrupted write never leaves a half-written file behind. The pattern is explained in ",[53,1922,1924],{"href":1923},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis\u002F","writing files atomically in Python CLIs",[1889,1926,1928],{"id":1927},"opening-the-users-editor","Opening the user’s editor",[10,1930,1931,1933,1934,1937,1938,1941,1942,1945,1946,1949,1950,588,1953,1956,1957,1960,1961,1964,1965,588,1968,1909,1971,1974],{},[14,1932,41],{}," follows the Unix convention: ",[14,1935,1936],{},"$VISUAL"," first, then ",[14,1939,1940],{},"$EDITOR",", then a platform default (",[14,1943,1944],{},"vi"," on Unix, ",[14,1947,1948],{},"notepad"," on Windows). The variable may contain arguments — ",[14,1951,1952],{},"code --wait",[14,1954,1955],{},"subl -w"," — so it is split with ",[14,1958,1959],{},"shlex.split"," rather than used as a single program name. The command runs the editor with the file path, waits for it to exit, and then ",[48,1962,1963],{},"validates"," the result. If the file is broken, it prints what is wrong and asks whether to edit again, which is exactly how ",[14,1966,1967],{},"git commit",[14,1969,1970],{},"crontab -e",[14,1972,1973],{},"visudo"," behave. In a non-interactive session it does not ask; it exits with status 1, so automation fails loudly instead of hanging on a prompt.",[10,1976,1977,1978,1980,1981,1984,1985,588,1987,588,1989,1992],{},"Graphical editors need their “wait” flag. ",[14,1979,14],{}," returns immediately unless given ",[14,1982,1983],{},"--wait",", which means the validation would run on the unchanged file. Document the common values (",[14,1986,1952],{},[14,1988,1955],{},[14,1990,1991],{},"gedit -s",") in the help text, or check whether the file’s modification time changed and warn when it did not.",[85,1994],{"name":1995},"cfgcmd-edit-loop",[1889,1997,1999],{"id":1998},"changing-one-value-without-losing-comments","Changing one value without losing comments",[10,2001,2002,2004,2005,2008,2009,2011,2012,2015,2016,2019],{},[14,2003,45],{}," is where most implementations go wrong. Loading the file with ",[14,2006,2007],{},"tomllib",", changing a dictionary and writing it back with a TOML serialiser throws away every comment, blank line and key ordering the user chose. ",[48,2010,50],{}," parses TOML into a document object that remembers all of that: assigning ",[14,2013,2014],{},"doc[\"api\"][\"timeout\"] = 60"," changes exactly one value, and ",[14,2017,2018],{},"tomlkit.dumps(doc)"," reproduces the rest of the file byte for byte.",[133,2021,2026],{"className":2022,"code":2024,"language":2025,"meta":138},[2023],"language-text","# before                                   # after: mytool config set api.timeout 60\n[api]                                      [api]\n# Seconds to wait for a response.          # Seconds to wait for a response.\ntimeout = 30                               timeout = 60\n","text",[14,2027,2024],{"__ignoreMap":138},[10,2029,2030,2031,2034,2035,2038,2039,2042,2043,2046,2047,588,2050,2053,2054,2057,2058,2061,2062,2064],{},"The value itself is parsed as a TOML expression, so ",[14,2032,2033],{},"60"," becomes an integer, ",[14,2036,2037],{},"true"," a boolean, ",[14,2040,2041],{},"\"60\""," a string and ",[14,2044,2045],{},"[\"a\", \"b\"]"," an array; anything that is not valid TOML — ",[14,2048,2049],{},"json",[14,2051,2052],{},"https:\u002F\u002Fx.example"," — falls back to a bare string. Dotted keys create missing tables on the way, so ",[14,2055,2056],{},"mytool config set cache.dir ~\u002F.cache\u002Fmytool"," works on an empty file. Before writing, the new text goes through the same ",[14,2059,2060],{},"validate"," function as ",[14,2063,41],{},", so a script cannot store a value that the loader would reject later.",[10,2066,2067,2069,2070,2072,2073,2076],{},[14,2068,121],{}," reads with the standard library’s ",[14,2071,2007],{},", since it never writes, and walks the dotted key. It prints only the value on stdout, which makes ",[14,2074,2075],{},"timeout=$(mytool config get api.timeout)"," work in shell scripts; errors go to stderr with a non-zero exit code.",[85,2078],{"name":2079},"cfgcmd-tomlkit",[59,2081,2083],{"id":2082},"ux-considerations","UX considerations",[64,2085,2086,2103,2118,2132,2145],{},[67,2087,2088,2091,2092,588,2094,1909,2096,2098,2099,2102],{},[48,2089,2090],{},"Print the path, always."," ",[14,2093,104],{},[14,2095,41],{},[14,2097,45],{}," mention the file they touched, on stderr. Users with several profiles or a ",[14,2100,2101],{},"MYTOOL_CONFIG"," override need to see which file changed.",[67,2104,2105,2091,2108,2111,2112,2114,2115,2117],{},[48,2106,2107],{},"Respect overrides.",[14,2109,2110],{},"config_path()"," honours the same ",[14,2113,2101],{}," variable the loader uses; otherwise ",[14,2116,41],{}," opens one file while the CLI reads another.",[67,2119,2120,2091,2123,588,2125,2127,2128,57],{},[48,2121,2122],{},"Validate in one place.",[14,2124,41],{},[14,2126,45],{}," and the runtime loader should share the same validation function — or better, the same settings model, as in ",[53,2129,2131],{"href":2130},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings\u002F","typed settings with pydantic-settings",[67,2133,2134,2137,2138,2140,2141,57],{},[48,2135,2136],{},"Never echo secrets."," If the file can hold tokens, ",[14,2139,121],{}," should refuse those keys or mask them, and the template should point to a keyring instead, as in ",[53,2142,2144],{"href":2143},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring\u002F","storing tokens with keyring",[67,2146,2147,2091,2150,2152,2153,2156],{},[48,2148,2149],{},"Show effective values separately.",[14,2151,28],{}," reports the file; a ",[14,2154,2155],{},"config show"," that merges flags, environment and file — and says where each value came from — answers the more common question “why is it using that?”.",[59,2158,2160],{"id":2159},"testing-the-behaviour","Testing the behaviour",[10,2162,2163,2164,2166,2167,2169,2170,2172],{},"Each test points ",[14,2165,2101],{}," at a temporary file, so the user’s real configuration is never touched. The editor is replaced by a tiny Python script set as ",[14,2168,1936],{},", which makes the full ",[14,2171,41],{}," path — launching, waiting, validating — run in the test without any interactive program:",[133,2174,2176],{"className":135,"code":2175,"language":137,"meta":138,"style":138},"# tests\u002Ftest_config_cmd.py\nimport sys\n\nimport pytest\nfrom typer.testing import CliRunner\n\nfrom mytool.config_cmd import app\n\nrunner = CliRunner()\n\n\n@pytest.fixture\ndef cfg(tmp_path, monkeypatch):\n    path = tmp_path \u002F \"config.toml\"\n    monkeypatch.setenv(\"MYTOOL_CONFIG\", str(path))\n    return path\n\n\ndef test_init_writes_commented_template_once(cfg):\n    assert runner.invoke(app, [\"init\"]).exit_code == 0\n    assert \"# Seconds to wait for a response.\" in cfg.read_text()\n    assert runner.invoke(app, [\"init\"]).exit_code == 1\n\n\ndef test_set_preserves_comments_and_types(cfg):\n    runner.invoke(app, [\"init\"])\n    assert runner.invoke(app, [\"set\", \"api.timeout\", \"60\"]).exit_code == 0\n    text = cfg.read_text()\n    assert \"timeout = 60\" in text and \"# Seconds to wait\" in text\n    assert runner.invoke(app, [\"get\", \"api.timeout\"]).stdout == \"60\\n\"\n\n\ndef test_set_rejects_invalid_values(cfg):\n    runner.invoke(app, [\"init\"])\n    result = runner.invoke(app, [\"set\", \"output.format\", \"xml\"])\n    assert result.exit_code == 1 and \"output.format must be\" in result.stderr\n    assert 'format = \"table\"' in cfg.read_text()\n\n\ndef test_edit_runs_editor_and_validates(cfg, monkeypatch, tmp_path):\n    runner.invoke(app, [\"init\"])\n    fake = tmp_path \u002F \"fake_editor.py\"\n    fake.write_text(\"import sys, pathlib\\np = pathlib.Path(sys.argv[1])\\n\"\n                    \"p.write_text(p.read_text().replace('timeout = 30', 'timeout = 5'))\\n\")\n    monkeypatch.setenv(\"VISUAL\", f\"{sys.executable} {fake}\")\n    result = runner.invoke(app, [\"edit\"])\n    assert result.exit_code == 0 and \"timeout = 5\" in cfg.read_text()\n\n\ndef test_edit_reports_broken_file(cfg, monkeypatch, tmp_path):\n    runner.invoke(app, [\"init\"])\n    fake = tmp_path \u002F \"break.py\"\n    fake.write_text(\"import sys, pathlib\\npathlib.Path(sys.argv[1]).write_text('[api\\\\n')\\n\")\n    monkeypatch.setenv(\"VISUAL\", f\"{sys.executable} {fake}\")\n    result = runner.invoke(app, [\"edit\"])\n    assert result.exit_code == 1 and \"not valid TOML\" in result.stderr\n",[14,2177,2178,2183,2189,2193,2200,2212,2216,2228,2232,2242,2246,2250,2255,2265,2279,2293,2300,2304,2308,2318,2337,2349,2364,2368,2372,2381,2391,2414,2422,2444,2470,2474,2478,2487,2495,2518,2541,2552,2556,2560,2570,2578,2592,2609,2620,2651,2664,2683,2687,2691,2700,2708,2721,2744,2772,2784],{"__ignoreMap":138},[142,2179,2180],{"class":144,"line":145},[142,2181,2182],{"class":148},"# tests\u002Ftest_config_cmd.py\n",[142,2184,2185,2187],{"class":144,"line":152},[142,2186,180],{"class":155},[142,2188,207],{"class":166},[142,2190,2191],{"class":144,"line":170},[142,2192,174],{"emptyLinePlaceholder":173},[142,2194,2195,2197],{"class":144,"line":177},[142,2196,180],{"class":155},[142,2198,2199],{"class":166}," pytest\n",[142,2201,2202,2204,2207,2209],{"class":144,"line":186},[142,2203,156],{"class":155},[142,2205,2206],{"class":166}," typer.testing ",[142,2208,180],{"class":155},[142,2210,2211],{"class":166}," CliRunner\n",[142,2213,2214],{"class":144,"line":194},[142,2215,174],{"emptyLinePlaceholder":173},[142,2217,2218,2220,2223,2225],{"class":144,"line":202},[142,2219,156],{"class":155},[142,2221,2222],{"class":166}," mytool.config_cmd ",[142,2224,180],{"class":155},[142,2226,2227],{"class":166}," app\n",[142,2229,2230],{"class":144,"line":210},[142,2231,174],{"emptyLinePlaceholder":173},[142,2233,2234,2237,2239],{"class":144,"line":218},[142,2235,2236],{"class":166},"runner ",[142,2238,386],{"class":155},[142,2240,2241],{"class":166}," CliRunner()\n",[142,2243,2244],{"class":144,"line":231},[142,2245,174],{"emptyLinePlaceholder":173},[142,2247,2248],{"class":144,"line":244},[142,2249,174],{"emptyLinePlaceholder":173},[142,2251,2252],{"class":144,"line":249},[142,2253,2254],{"class":420},"@pytest.fixture\n",[142,2256,2257,2259,2262],{"class":144,"line":257},[142,2258,417],{"class":155},[142,2260,2261],{"class":420}," cfg",[142,2263,2264],{"class":166},"(tmp_path, monkeypatch):\n",[142,2266,2267,2269,2271,2274,2276],{"class":144,"line":265},[142,2268,887],{"class":166},[142,2270,386],{"class":155},[142,2272,2273],{"class":166}," tmp_path ",[142,2275,29],{"class":155},[142,2277,2278],{"class":292}," \"config.toml\"\n",[142,2280,2281,2284,2286,2288,2290],{"class":144,"line":278},[142,2282,2283],{"class":166},"    monkeypatch.setenv(",[142,2285,436],{"class":292},[142,2287,588],{"class":166},[142,2289,481],{"class":159},[142,2291,2292],{"class":166},"(path))\n",[142,2294,2295,2297],{"class":144,"line":283},[142,2296,430],{"class":155},[142,2298,2299],{"class":166}," path\n",[142,2301,2302],{"class":144,"line":299},[142,2303,174],{"emptyLinePlaceholder":173},[142,2305,2306],{"class":144,"line":305},[142,2307,174],{"emptyLinePlaceholder":173},[142,2309,2310,2312,2315],{"class":144,"line":311},[142,2311,417],{"class":155},[142,2313,2314],{"class":420}," test_init_writes_commented_template_once",[142,2316,2317],{"class":166},"(cfg):\n",[142,2319,2320,2323,2326,2329,2332,2334],{"class":144,"line":316},[142,2321,2322],{"class":155},"    assert",[142,2324,2325],{"class":166}," runner.invoke(app, [",[142,2327,2328],{"class":292},"\"init\"",[142,2330,2331],{"class":166},"]).exit_code ",[142,2333,1102],{"class":155},[142,2335,2336],{"class":159}," 0\n",[142,2338,2339,2341,2344,2346],{"class":144,"line":322},[142,2340,2322],{"class":155},[142,2342,2343],{"class":292}," \"# Seconds to wait for a response.\"",[142,2345,671],{"class":155},[142,2347,2348],{"class":166}," cfg.read_text()\n",[142,2350,2351,2353,2355,2357,2359,2361],{"class":144,"line":328},[142,2352,2322],{"class":155},[142,2354,2325],{"class":166},[142,2356,2328],{"class":292},[142,2358,2331],{"class":166},[142,2360,1102],{"class":155},[142,2362,2363],{"class":159}," 1\n",[142,2365,2366],{"class":144,"line":334},[142,2367,174],{"emptyLinePlaceholder":173},[142,2369,2370],{"class":144,"line":340},[142,2371,174],{"emptyLinePlaceholder":173},[142,2373,2374,2376,2379],{"class":144,"line":346},[142,2375,417],{"class":155},[142,2377,2378],{"class":420}," test_set_preserves_comments_and_types",[142,2380,2317],{"class":166},[142,2382,2383,2386,2388],{"class":144,"line":351},[142,2384,2385],{"class":166},"    runner.invoke(app, [",[142,2387,2328],{"class":292},[142,2389,2390],{"class":166},"])\n",[142,2392,2393,2395,2397,2399,2401,2404,2406,2408,2410,2412],{"class":144,"line":357},[142,2394,2322],{"class":155},[142,2396,2325],{"class":166},[142,2398,1505],{"class":292},[142,2400,588],{"class":166},[142,2402,2403],{"class":292},"\"api.timeout\"",[142,2405,588],{"class":166},[142,2407,2041],{"class":292},[142,2409,2331],{"class":166},[142,2411,1102],{"class":155},[142,2413,2336],{"class":159},[142,2415,2416,2418,2420],{"class":144,"line":363},[142,2417,1648],{"class":166},[142,2419,386],{"class":155},[142,2421,2348],{"class":166},[142,2423,2424,2426,2429,2431,2434,2436,2439,2441],{"class":144,"line":369},[142,2425,2322],{"class":155},[142,2427,2428],{"class":292}," \"timeout = 60\"",[142,2430,671],{"class":155},[142,2432,2433],{"class":166}," text ",[142,2435,903],{"class":155},[142,2437,2438],{"class":292}," \"# Seconds to wait\"",[142,2440,671],{"class":155},[142,2442,2443],{"class":166}," text\n",[142,2445,2446,2448,2450,2452,2454,2456,2459,2461,2464,2467],{"class":144,"line":375},[142,2447,2322],{"class":155},[142,2449,2325],{"class":166},[142,2451,1729],{"class":292},[142,2453,588],{"class":166},[142,2455,2403],{"class":292},[142,2457,2458],{"class":166},"]).stdout ",[142,2460,1102],{"class":155},[142,2462,2463],{"class":292}," \"60",[142,2465,2466],{"class":159},"\\n",[142,2468,2469],{"class":292},"\"\n",[142,2471,2472],{"class":144,"line":380},[142,2473,174],{"emptyLinePlaceholder":173},[142,2475,2476],{"class":144,"line":404},[142,2477,174],{"emptyLinePlaceholder":173},[142,2479,2480,2482,2485],{"class":144,"line":409},[142,2481,417],{"class":155},[142,2483,2484],{"class":420}," test_set_rejects_invalid_values",[142,2486,2317],{"class":166},[142,2488,2489,2491,2493],{"class":144,"line":414},[142,2490,2385],{"class":166},[142,2492,2328],{"class":292},[142,2494,2390],{"class":166},[142,2496,2497,2500,2502,2504,2506,2508,2511,2513,2516],{"class":144,"line":427},[142,2498,2499],{"class":166},"    result ",[142,2501,386],{"class":155},[142,2503,2325],{"class":166},[142,2505,1505],{"class":292},[142,2507,588],{"class":166},[142,2509,2510],{"class":292},"\"output.format\"",[142,2512,588],{"class":166},[142,2514,2515],{"class":292},"\"xml\"",[142,2517,2390],{"class":166},[142,2519,2520,2522,2525,2527,2530,2533,2536,2538],{"class":144,"line":460},[142,2521,2322],{"class":155},[142,2523,2524],{"class":166}," result.exit_code ",[142,2526,1102],{"class":155},[142,2528,2529],{"class":159}," 1",[142,2531,2532],{"class":155}," and",[142,2534,2535],{"class":292}," \"output.format must be\"",[142,2537,671],{"class":155},[142,2539,2540],{"class":166}," result.stderr\n",[142,2542,2543,2545,2548,2550],{"class":144,"line":465},[142,2544,2322],{"class":155},[142,2546,2547],{"class":292}," 'format = \"table\"'",[142,2549,671],{"class":155},[142,2551,2348],{"class":166},[142,2553,2554],{"class":144,"line":470},[142,2555,174],{"emptyLinePlaceholder":173},[142,2557,2558],{"class":144,"line":492},[142,2559,174],{"emptyLinePlaceholder":173},[142,2561,2562,2564,2567],{"class":144,"line":501},[142,2563,417],{"class":155},[142,2565,2566],{"class":420}," test_edit_runs_editor_and_validates",[142,2568,2569],{"class":166},"(cfg, monkeypatch, tmp_path):\n",[142,2571,2572,2574,2576],{"class":144,"line":512},[142,2573,2385],{"class":166},[142,2575,2328],{"class":292},[142,2577,2390],{"class":166},[142,2579,2580,2583,2585,2587,2589],{"class":144,"line":527},[142,2581,2582],{"class":166},"    fake ",[142,2584,386],{"class":155},[142,2586,2273],{"class":166},[142,2588,29],{"class":155},[142,2590,2591],{"class":292}," \"fake_editor.py\"\n",[142,2593,2594,2597,2600,2602,2605,2607],{"class":144,"line":557},[142,2595,2596],{"class":166},"    fake.write_text(",[142,2598,2599],{"class":292},"\"import sys, pathlib",[142,2601,2466],{"class":159},[142,2603,2604],{"class":292},"p = pathlib.Path(sys.argv[1])",[142,2606,2466],{"class":159},[142,2608,2469],{"class":292},[142,2610,2611,2614,2616,2618],{"class":144,"line":568},[142,2612,2613],{"class":292},"                    \"p.write_text(p.read_text().replace('timeout = 30', 'timeout = 5'))",[142,2615,2466],{"class":159},[142,2617,551],{"class":292},[142,2619,401],{"class":166},[142,2621,2622,2624,2626,2628,2630,2632,2634,2637,2639,2642,2645,2647,2649],{"class":144,"line":596},[142,2623,2283],{"class":166},[142,2625,1075],{"class":292},[142,2627,588],{"class":166},[142,2629,536],{"class":155},[142,2631,551],{"class":292},[142,2633,542],{"class":159},[142,2635,2636],{"class":166},"sys.executable",[142,2638,548],{"class":159},[142,2640,2641],{"class":159}," {",[142,2643,2644],{"class":166},"fake",[142,2646,548],{"class":159},[142,2648,551],{"class":292},[142,2650,401],{"class":166},[142,2652,2653,2655,2657,2659,2662],{"class":144,"line":635},[142,2654,2499],{"class":166},[142,2656,386],{"class":155},[142,2658,2325],{"class":166},[142,2660,2661],{"class":292},"\"edit\"",[142,2663,2390],{"class":166},[142,2665,2666,2668,2670,2672,2674,2676,2679,2681],{"class":144,"line":646},[142,2667,2322],{"class":155},[142,2669,2524],{"class":166},[142,2671,1102],{"class":155},[142,2673,630],{"class":159},[142,2675,2532],{"class":155},[142,2677,2678],{"class":292}," \"timeout = 5\"",[142,2680,671],{"class":155},[142,2682,2348],{"class":166},[142,2684,2685],{"class":144,"line":692},[142,2686,174],{"emptyLinePlaceholder":173},[142,2688,2689],{"class":144,"line":702},[142,2690,174],{"emptyLinePlaceholder":173},[142,2692,2693,2695,2698],{"class":144,"line":710},[142,2694,417],{"class":155},[142,2696,2697],{"class":420}," test_edit_reports_broken_file",[142,2699,2569],{"class":166},[142,2701,2702,2704,2706],{"class":144,"line":715},[142,2703,2385],{"class":166},[142,2705,2328],{"class":292},[142,2707,2390],{"class":166},[142,2709,2710,2712,2714,2716,2718],{"class":144,"line":720},[142,2711,2582],{"class":166},[142,2713,386],{"class":155},[142,2715,2273],{"class":166},[142,2717,29],{"class":155},[142,2719,2720],{"class":292}," \"break.py\"\n",[142,2722,2723,2725,2727,2729,2732,2735,2738,2740,2742],{"class":144,"line":741},[142,2724,2596],{"class":166},[142,2726,2599],{"class":292},[142,2728,2466],{"class":159},[142,2730,2731],{"class":292},"pathlib.Path(sys.argv[1]).write_text('[api",[142,2733,2734],{"class":159},"\\\\",[142,2736,2737],{"class":292},"n')",[142,2739,2466],{"class":159},[142,2741,551],{"class":292},[142,2743,401],{"class":166},[142,2745,2746,2748,2750,2752,2754,2756,2758,2760,2762,2764,2766,2768,2770],{"class":144,"line":766},[142,2747,2283],{"class":166},[142,2749,1075],{"class":292},[142,2751,588],{"class":166},[142,2753,536],{"class":155},[142,2755,551],{"class":292},[142,2757,542],{"class":159},[142,2759,2636],{"class":166},[142,2761,548],{"class":159},[142,2763,2641],{"class":159},[142,2765,2644],{"class":166},[142,2767,548],{"class":159},[142,2769,551],{"class":292},[142,2771,401],{"class":166},[142,2773,2774,2776,2778,2780,2782],{"class":144,"line":794},[142,2775,2499],{"class":166},[142,2777,386],{"class":155},[142,2779,2325],{"class":166},[142,2781,2661],{"class":292},[142,2783,2390],{"class":166},[142,2785,2786,2788,2790,2792,2794,2796,2799,2801],{"class":144,"line":810},[142,2787,2322],{"class":155},[142,2789,2524],{"class":166},[142,2791,1102],{"class":155},[142,2793,2529],{"class":159},[142,2795,2532],{"class":155},[142,2797,2798],{"class":292}," \"not valid TOML\"",[142,2800,671],{"class":155},[142,2802,2540],{"class":166},[10,2804,2805,2806,2808,2809,2812],{},"The fake editor trick generalises: any command that launches an external program configured through an environment variable can be tested by pointing that variable at ",[14,2807,2636],{}," plus a short script. Typer’s ",[14,2810,2811],{},"CliRunner"," has no TTY on stdin, so the broken-file test exercises the non-interactive branch and checks that it exits instead of prompting.",[59,2814,2816],{"id":2815},"conclusion","Conclusion",[10,2818,2819,2820,2822,2823,2825,2826,2828,2829,2831,2832,2834,2835,2838,2839,2841,2842,2844],{},"A config command family turns a hidden file into a discoverable feature. Write a commented template with ",[14,2821,104],{}," and refuse to overwrite without ",[14,2824,1905],{},"; open ",[14,2827,1936],{}," or ",[14,2830,1940],{}," with ",[14,2833,41],{},", split with ",[14,2836,2837],{},"shlex",", and validate afterwards with an offer to retry; change single values with ",[14,2840,45],{}," through tomlkit so comments and formatting survive; print plain values from ",[14,2843,121],{}," for scripts; write atomically; share validation with the runtime loader; and test the editor path with a fake editor script.",[59,2846,2848],{"id":2847},"frequently-asked-questions","Frequently asked questions",[1889,2850,2852,2853,2855],{"id":2851},"why-not-let-set-rewrite-the-file-with-a-regular-toml-writer","Why not let ",[14,2854,45],{}," rewrite the file with a regular TOML writer?",[10,2857,2858],{},"Because it deletes the user’s comments and reorders keys. Users annotate configuration files (“raised for the slow VPN”); a tool that silently removes those notes loses trust quickly. tomlkit exists precisely to avoid that.",[1889,2860,2862],{"id":2861},"what-if-my-configuration-is-yaml-not-toml","What if my configuration is YAML, not TOML?",[10,2864,2865,2866,2869,2870,2874],{},"The same command family works. ",[14,2867,2868],{},"ruamel.yaml"," in round-trip mode plays the role of tomlkit, preserving comments and ordering, while the safe-loading rules in ",[53,2871,2873],{"href":2872},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Floading-yaml-configs-safely-in-cli-apps\u002F","loading YAML configs safely in CLI apps"," still apply to reading.",[1889,2876,2878,2879,2881],{"id":2877},"should-config-edit-create-the-file-if-it-does-not-exist","Should ",[14,2880,24],{}," create the file if it does not exist?",[10,2883,2884],{},"Yes — starting from the commented template, as above, is far more helpful than an empty buffer. Print that you created it, so users are not surprised to find a new file.",[1889,2886,2888,2889,2892],{"id":2887},"can-i-use-clickedit-instead-of-launching-the-editor-myself","Can I use ",[14,2890,2891],{},"click.edit()"," instead of launching the editor myself?",[10,2894,2895,2898,2899,29,2901,2903,2904,2907,2908,2911,2912,57],{},[14,2896,2897],{},"click.edit(filename=...)"," does the same job and handles the ",[14,2900,1936],{},[14,2902,1940],{}," lookup. Typer bundles its own copy of Click, so call it through ",[14,2905,2906],{},"typer","’s Click if you need it; the explicit ",[14,2909,2910],{},"subprocess.run"," above is easier to test and to explain. Launching editors in general is covered in ",[53,2913,2915],{"href":2914},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Flaunching-the-users-editor-from-a-cli\u002F","launching the user’s editor from a CLI",[1889,2917,2919,2920,2922],{"id":2918},"how-should-set-handle-unknown-keys","How should ",[14,2921,45],{}," handle unknown keys?",[10,2924,2925,2926,2929,2930,2934],{},"Reject them, with a suggestion when one is close — ",[14,2927,2928],{},"api.timout"," should produce “unknown key, did you mean api.timeout?”, as in ",[53,2931,2933],{"href":2932},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fdid-you-mean-suggestions-for-mistyped-input\u002F","did you mean suggestions for mistyped input",". A typo silently stored in the file is a setting that never takes effect.",[59,2936,2938],{"id":2937},"related","Related",[64,2940,2941,2947,2952,2957,2963],{},[67,2942,2943,2944],{},"Up: ",[53,2945,2946],{"href":55},"Configuration files and environment variables",[67,2948,2949],{},[53,2950,2951],{"href":72},"Reading TOML config with tomllib",[67,2953,2954],{},[53,2955,2956],{"href":125},"Config precedence: flags, env, files and defaults",[67,2958,2959],{},[53,2960,2962],{"href":2961},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fvalidating-config-files-with-json-schema\u002F","Validating config files with JSON Schema",[67,2964,2965],{},[53,2966,2967],{"href":2914},"Launching the user’s editor from a CLI",[2969,2970,2971],"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 .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 pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}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":138,"searchDepth":152,"depth":152,"links":2973},[2974,2975,2976,2981,2982,2983,2984,2995],{"id":61,"depth":152,"text":62},{"id":82,"depth":152,"text":83},{"id":130,"depth":152,"text":131,"children":2977},[2978,2979,2980],{"id":1891,"depth":170,"text":1892},{"id":1927,"depth":170,"text":1928},{"id":1998,"depth":170,"text":1999},{"id":2082,"depth":152,"text":2083},{"id":2159,"depth":152,"text":2160},{"id":2815,"depth":152,"text":2816},{"id":2847,"depth":152,"text":2848,"children":2985},[2986,2988,2989,2991,2993],{"id":2851,"depth":170,"text":2987},"Why not let set rewrite the file with a regular TOML writer?",{"id":2861,"depth":170,"text":2862},{"id":2877,"depth":170,"text":2990},"Should config edit create the file if it does not exist?",{"id":2887,"depth":170,"text":2992},"Can I use click.edit() instead of launching the editor myself?",{"id":2918,"depth":170,"text":2994},"How should set handle unknown keys?",{"id":2937,"depth":152,"text":2938},"2026-10-02","Give users config init, edit, get and set commands: a commented starter file, their editor with validation afterwards, and comment-preserving edits via tomlkit.","intermediate",false,"md",{},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fwriting-a-config-init-and-edit-command",{"title":5,"description":2997},"advanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fwriting-a-config-init-and-edit-command\u002Findex",[3006,3007,50,3008,2906],"configuration","toml","editor","z7MVIsbtRhrchNRjb6GfmkhFY4uNOVRCFNpd9bQ31_E",[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,3144,3147,3150,3153,3156,3159,3162,3165,3168,3171,3174,3177,3180,3183,3186,3189,3192,3195,3198,3201,3204,3207,3210,3213,3216,3219,3222,3225,3228,3231,3234,3237,3240,3243,3246,3249,3252,3255,3258,3261,3264,3267,3270,3273,3276,3279,3282,3285,3288,3291,3294,3297,3300,3303,3306,3309,3312,3315,3318,3321,3324,3327,3330,3333,3336,3339,3342,3345,3348,3351,3354,3357,3360,3363,3366,3369,3372,3375,3378,3381,3384,3387,3390,3393,3396,3399,3402,3405,3408,3411,3414,3417,3420,3423,3426,3428,3431,3434,3437,3440,3443,3446,3449,3452,3455,3458,3461,3464,3467,3470,3473,3476,3479,3482,3485,3488,3491,3494,3497,3500,3503,3506,3509,3512,3515,3518,3521,3524,3527,3530,3533,3536,3539,3542,3545,3548,3551,3554,3557,3560,3563,3566,3569,3572,3575,3578,3581,3584,3587,3590,3593,3596,3599,3602,3605,3608,3611,3614,3617,3620,3623,3626,3629,3632,3635,3638,3641,3644,3647,3650,3653,3656,3659,3662,3665,3668,3671,3674,3677,3680,3683,3686,3689,3692,3695,3698,3701,3704,3707,3710,3713,3716,3719,3722,3725,3728,3731,3734,3737,3740,3743,3746,3749,3752,3755,3758,3761,3764,3767,3770,3773,3776,3779,3782,3785,3788,3791,3794,3797,3800,3803,3806,3809,3812,3815,3818,3821,3824,3827,3830,3833,3836,3839,3842,3845,3848,3851],{"path":3012,"title":3013},"\u002Fabout","About Python CLI Toolcraft",{"path":3015,"title":3016},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":3018,"title":3019},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":3021,"title":3022},"\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":3024,"title":3025},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":3027,"title":3028},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":3030,"title":3031},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-urls-hosts-and-ports","Validating URLs, Hosts and Ports in Python CLI Arguments",{"path":3033,"title":3034},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":3036,"title":3037},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbrowsing-records-with-a-textual-datatable","Browsing Records with a Textual DataTable Picker",{"path":3039,"title":3040},"\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":3042,"title":3043},"\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":3045,"title":3046},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":3048,"title":3049},"\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":3051,"title":3052},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fstyling-textual-apps-with-tcss","Styling Textual Apps with TCSS",{"path":3054,"title":3055},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":3057,"title":3058},"\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":3060,"title":3061},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fdocumenting-environment-variables-in-help","Documenting Environment Variables in CLI Help",{"path":3063,"title":3064},"\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":3066,"title":3067},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":3069,"title":3070},"\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":3072,"title":3073},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":3075,"title":3076},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":3078,"title":3079},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":3081,"title":3082},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":3084,"title":3085},"\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":3087,"title":3088},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fhandling-ansi-escape-codes-on-windows-consoles","Handling ANSI Escape Codes on Windows Consoles",{"path":3090,"title":3091},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":3093,"title":3094},"\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":3096,"title":3097},"\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":3099,"title":3100},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":3102,"title":3103},"\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":3105,"title":3106},"\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":3108,"title":3109},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":3111,"title":3112},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":3114,"title":3115},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":3117,"title":3118},"\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":3120,"title":3121},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fwriting-crash-reports-users-can-send","Writing Crash Reports Users Can Send",{"path":3123,"title":3124},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":3126,"title":3127},"\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":3129,"title":3130},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":3132,"title":3133},"\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":3135,"title":3136},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":3138,"title":3139},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":3141,"title":3142},"\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":3002,"title":5},{"path":3145,"title":3146},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":3148,"title":3149},"\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":3151,"title":3152},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":3154,"title":3155},"\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":3157,"title":3158},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":3160,"title":3161},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":3163,"title":3164},"\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":3166,"title":3167},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":3169,"title":3170},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":3172,"title":3173},"\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":3175,"title":3176},"\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":3178,"title":3179},"\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":3181,"title":3182},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis","Output Formats for Data-Heavy Python CLIs",{"path":3184,"title":3185},"\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":3187,"title":3188},"\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":3190,"title":3191},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fargcomplete-for-argparse-clis","Tab Completion for argparse CLIs with argcomplete",{"path":3193,"title":3194},"\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":3196,"title":3197},"\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":3199,"title":3200},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":3202,"title":3203},"\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":3205,"title":3206},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages","Shipping Shell Completion Scripts with a Python CLI",{"path":3208,"title":3209},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":3211,"title":3212},"\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":3214,"title":3215},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":3217,"title":3218},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":3220,"title":3221},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Flogging-with-structlog-in-a-cli","Logging with structlog in a Python CLI",{"path":3223,"title":3224},"\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":3226,"title":3227},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":3229,"title":3230},"\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":3232,"title":3233},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":3235,"title":3236},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":3238,"title":3239},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":3241,"title":3242},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":3244,"title":3245},"\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":3247,"title":3248},"\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":3250,"title":3251},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":3253,"title":3254},"\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":3256,"title":3257},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":3259,"title":3260},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":3262,"title":3263},"\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":3265,"title":3266},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":3268,"title":3269},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":3271,"title":3272},"\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":3274,"title":3275},"\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":3277,"title":3278},"\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":3280,"title":3281},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":3283,"title":3284},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":3286,"title":3287},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":3289,"title":3290},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":3292,"title":3293},"\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":3295,"title":3296},"\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":3298,"title":3299},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fstructured-concurrency-with-taskgroups-in-clis","Structured Concurrency with TaskGroups in Python CLIs",{"path":3301,"title":3302},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":3304,"title":3305},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":3307,"title":3308},"\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":3310,"title":3311},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":3313,"title":3314},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":3316,"title":3317},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":3319,"title":3320},"\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":3322,"title":3323},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":3325,"title":3326},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":3328,"title":3329},"\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":3331,"title":3332},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis","Local State and SQLite in Python CLIs",{"path":3334,"title":3335},"\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":3337,"title":3338},"\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":3340,"title":3341},"\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":3343,"title":3344},"\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":3346,"title":3347},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":3349,"title":3350},"\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":3352,"title":3353},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":3355,"title":3356},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Freloading-config-on-sighup","Reloading Configuration on SIGHUP in a Python CLI",{"path":3358,"title":3359},"\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":3361,"title":3362},"\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":3364,"title":3365},"\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":3367,"title":3368},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":3370,"title":3371},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":3373,"title":3374},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":3376,"title":3377},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":3379,"title":3380},"\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":3382,"title":3383},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fpiping-between-subprocesses-in-python","Piping Between Subprocesses in Python Without a Shell",{"path":3385,"title":3386},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":3388,"title":3389},"\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":3391,"title":3392},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":3394,"title":3395},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":3397,"title":3398},"\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":3400,"title":3401},"\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":3403,"title":3404},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Frefreshing-expired-tokens-automatically","Refreshing Expired Tokens Automatically in a Python CLI",{"path":3406,"title":3407},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":3409,"title":3410},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":3412,"title":3413},"\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":3415,"title":3416},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis","Update Checks, Upgrade Commands and Telemetry for Python CLIs",{"path":3418,"title":3419},"\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":3421,"title":3422},"\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":3424,"title":3425},"\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":29,"title":3427},"Python CLI Toolcraft",{"path":3429,"title":3430},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo","Building a Python CLI with Cleo Command Classes",{"path":3432,"title":3433},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts","Building a Type-Hinted Python CLI with Cyclopts",{"path":3435,"title":3436},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks","Beyond Click and Typer: Alternative Python CLI Frameworks",{"path":3438,"title":3439},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fquick-clis-from-functions-with-python-fire","Quick CLIs from Functions with Python Fire",{"path":3441,"title":3442},"\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":3444,"title":3445},"\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":3447,"title":3448},"\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":3450,"title":3451},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fguarding-startup-with-import-tests","Guarding CLI Startup with Import Tests",{"path":3453,"title":3454},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":3456,"title":3457},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":3459,"title":3460},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":3462,"title":3463},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":3465,"title":3466},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":3468,"title":3469},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":3471,"title":3472},"\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":3474,"title":3475},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":3477,"title":3478},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":3480,"title":3481},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":3483,"title":3484},"\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":3486,"title":3487},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":3489,"title":3490},"\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":3492,"title":3493},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fdesigning-idempotent-commands","Designing Idempotent Commands in a Python CLI",{"path":3495,"title":3496},"\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":3498,"title":3499},"\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":3501,"title":3502},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":3504,"title":3505},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":3507,"title":3508},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fpositional-arguments-vs-options","Positional Arguments vs Options: Designing a CLI Signature",{"path":3510,"title":3511},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":3513,"title":3514},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":3516,"title":3517},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":3519,"title":3520},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":3522,"title":3523},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures","Isolating Plugin Failures in an Extensible Python CLI",{"path":3525,"title":3526},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli","Testing Plugins Against the Host CLI",{"path":3528,"title":3529},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":3531,"title":3532},"\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":3534,"title":3535},"\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":3537,"title":3538},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":3540,"title":3541},"\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":3543,"title":3544},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":3546,"title":3547},"\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":3549,"title":3550},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically","Registering CLI Commands from Modules Automatically",{"path":3552,"title":3553},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":3555,"title":3556},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":3558,"title":3559},"\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":3561,"title":3562},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":3564,"title":3565},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":3567,"title":3568},"\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":3570,"title":3571},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":3573,"title":3574},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":3576,"title":3577},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":3579,"title":3580},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-commands-that-call-subprocesses","Testing Python CLI Commands That Call Subprocesses",{"path":3582,"title":3583},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":3585,"title":3586},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands","Transcript Tests for Python CLI Commands",{"path":3588,"title":3589},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-a-cli-with-subcommands-in-click","Building a CLI with subcommands in Click",{"path":3591,"title":3592},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":3594,"title":3595},"\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":3597,"title":3598},"\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":3600,"title":3601},"\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":3603,"title":3604},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":3606,"title":3607},"\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":3609,"title":3610},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":3612,"title":3613},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":3615,"title":3616},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":3618,"title":3619},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":3621,"title":3622},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":3624,"title":3625},"\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":3627,"title":3628},"\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":3630,"title":3631},"\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":3633,"title":3634},"\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":3636,"title":3637},"\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":3639,"title":3640},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":3642,"title":3643},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":3645,"title":3646},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":3648,"title":3649},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":3651,"title":3652},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftemplate-variables-and-conditional-files","Template Variables and Conditional Files in CLI Templates",{"path":3654,"title":3655},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftesting-a-project-template-with-pytest","Testing a CLI Project Template with pytest",{"path":3657,"title":3658},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fupdating-generated-projects-with-copier-update","Updating Generated CLI Projects with copier update",{"path":3660,"title":3661},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":3663,"title":3664},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":3666,"title":3667},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fcode-signing-and-notarizing-cli-binaries","Code Signing and Notarizing Python CLI Binaries",{"path":3669,"title":3670},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":3672,"title":3673},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":3675,"title":3676},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":3678,"title":3679},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Freducing-pyinstaller-binary-size","Reducing the Size of a PyInstaller CLI Binary",{"path":3681,"title":3682},"\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":3684,"title":3685},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":3687,"title":3688},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":3690,"title":3691},"\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":3693,"title":3694},"\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":3696,"title":3697},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":3699,"title":3700},"\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":3702,"title":3703},"\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":3705,"title":3706},"\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":3708,"title":3709},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":3711,"title":3712},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fbumping-versions-consistently-across-a-cli-project","Bumping Versions Consistently Across a Python CLI Project",{"path":3714,"title":3715},"\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":3717,"title":3718},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":3720,"title":3721},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":3723,"title":3724},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":3726,"title":3727},"\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":3729,"title":3730},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":3732,"title":3733},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":3735,"title":3736},"\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":3738,"title":3739},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":3741,"title":3742},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":3744,"title":3745},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Foptional-dependencies-and-extras-for-clis","Optional Dependencies and Extras for Python CLIs",{"path":3747,"title":3748},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":3750,"title":3751},"\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":3753,"title":3754},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fdynamic-versioning-with-poetry-plugins","Dynamic Versioning for a Poetry CLI from Git Tags",{"path":3756,"title":3757},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":3759,"title":3760},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmanaging-poetry-lock-files-for-cli-tools","Managing Poetry Lock Files for CLI Tools",{"path":3762,"title":3763},"\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":3765,"title":3766},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":3768,"title":3769},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":3771,"title":3772},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpublishing-a-cli-with-poetry","Building and Publishing a Python CLI with Poetry",{"path":3774,"title":3775},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":3777,"title":3778},"\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":3780,"title":3781},"\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":3783,"title":3784},"\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":3786,"title":3787},"\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":3789,"title":3790},"\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":3792,"title":3793},"\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":3795,"title":3796},"\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":3798,"title":3799},"\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":3801,"title":3802},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain","Securing the Supply Chain of a Python CLI",{"path":3804,"title":3805},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpinning-dependencies-with-hashes","Pinning a Python CLI’s Dependencies with Hashes",{"path":3807,"title":3808},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpublishing-attestations-and-verifying-releases","Publishing Attestations and Verifying Python CLI Releases",{"path":3810,"title":3811},"\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":3813,"title":3814},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":3816,"title":3817},"\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":3819,"title":3820},"\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":3822,"title":3823},"\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":3825,"title":3826},"\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":3828,"title":3829},"\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":3831,"title":3832},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":3834,"title":3835},"\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":3837,"title":3838},"\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":3840,"title":3841},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":3843,"title":3844},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fisolating-cli-tools-from-project-dependencies","Isolating CLI Tools from Your Project’s Dependencies",{"path":3846,"title":3847},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":3849,"title":3850},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":3852,"title":3853},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1790967537209]