[{"data":1,"prerenderedAt":2228},["ShallowReactive",2],{"page-\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages\u002F":3,"content-directory":1384},{"id":4,"title":5,"body":6,"date":1371,"description":1372,"difficulty":1373,"draft":1374,"extension":1375,"meta":1376,"navigation":141,"path":1377,"seo":1378,"stem":1379,"tags":1380,"updated":1371,"__hash__":1383},"content\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages\u002Findex.md","Shipping Shell Completion Scripts with a Python CLI",{"type":7,"value":8,"toc":1349},"minimark",[9,29,34,48,52,56,78,82,90,93,482,509,513,525,579,582,585,589,592,624,661,665,668,798,801,805,855,858,862,865,1230,1240,1244,1255,1259,1263,1266,1270,1273,1277,1287,1291,1298,1302,1313,1317,1345],[10,11,12,13,17,18,23,24,28],"p",{},"Shell completion is one of those features users love and rarely set up. Click and Typer can complete commands, options and values, but the shell only asks your program for completions after something has registered a completion function — and a Python wheel cannot reliably put files where bash, zsh or fish look for them, especially when it is installed by pipx or uv into an isolated environment. The result is a CLI with excellent completion support that most people never see. This guide covers the delivery side: a ",[14,15,16],"code",{},"completion"," subcommand that prints the right script for each shell, the per-user directories where shells load completion files lazily, static scripts generated at release time for Homebrew and Linux packages, and tests that keep the scripts valid. It belongs to the ",[19,20,22],"a",{"href":21},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002F","shell completion topic","; enabling completion in the framework itself is covered in ",[19,25,27],{"href":26},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fenabling-tab-completion-in-click-and-typer\u002F","enabling tab completion in Click and Typer",".",[30,31,33],"h2",{"id":32},"prerequisites","Prerequisites",[35,36,37,41],"ul",{},[38,39,40],"li",{},"A Click or Typer CLI with working completion.",[38,42,43,44,28],{},"bash, zsh or fish to try the result; the release-time part assumes a Homebrew tap or Linux packages, as in ",[19,45,47],{"href":46},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis\u002F","Homebrew and Scoop packaging for Python CLIs",[30,49,51],{"id":50},"where-completion-scripts-can-come-from","Where completion scripts can come from",[53,54],"inline-diagram",{"name":55},"ship-completion-routes",[10,57,58,59,63,64,69,70,73,74,77],{},"There are four delivery routes, and a well-packaged CLI usually supports the first and third. A ",[60,61,62],"strong",{},"completion subcommand"," prints the script; users evaluate it from their shell profile or save it to a file. Typer's built-in ",[60,65,66],{},[14,67,68],{},"--install-completion"," edits the user's shell configuration for them. ",[60,71,72],{},"Package managers"," — Homebrew, Debian and RPM packages, conda — install static script files into system completion directories during installation. A ",[60,75,76],{},"wheel's data files"," can technically ship scripts too, but they land inside the installation prefix (a pipx or uv tool environment), where no shell looks — so this route rarely works for CLIs.",[30,79,81],{"id":80},"the-recipe","The recipe",[83,84,86,87,89],"h3",{"id":85},"a-completion-subcommand","A ",[14,88,16],{}," subcommand",[10,91,92],{},"Click exposes the machinery that generates scripts, so one command can print the script for any supported shell:",[94,95,100],"pre",{"className":96,"code":97,"language":98,"meta":99,"style":99},"language-python shiki shiki-themes github-light github-dark","# src\u002Fmytool\u002Fcli.py\nimport click\nfrom click.shell_completion import get_completion_class\n\n\n@click.group()\ndef cli() -> None:\n    \"\"\"My tool.\"\"\"\n\n\n@cli.command()\ndef status() -> None:\n    \"\"\"Show status.\"\"\"\n    click.echo(\"ok\")\n\n\n@cli.command()\n@click.argument(\"shell\", type=click.Choice([\"bash\", \"zsh\", \"fish\"]))\n@click.pass_context\ndef completion(ctx: click.Context, shell: str) -> None:\n    \"\"\"Print the completion script for SHELL.\n\n    \\b\n    bash:  mytool completion bash > ~\u002F.local\u002Fshare\u002Fbash-completion\u002Fcompletions\u002Fmytool\n    zsh:   mytool completion zsh > \"${fpath[1]}\u002F_mytool\"\n    fish:  mytool completion fish > ~\u002F.config\u002Ffish\u002Fcompletions\u002Fmytool.fish\n    \"\"\"\n    root = ctx.find_root()\n    prog = root.info_name or \"mytool\"\n    complete_var = f\"_{prog.replace('-', '_').upper()}_COMPLETE\"\n    script_class = get_completion_class(shell)\n    click.echo(script_class(root.command, {}, prog, complete_var).source())\n\n\ndef main() -> None:\n    cli(prog_name=\"mytool\")\n","python","",[14,101,102,111,122,136,143,148,158,177,184,189,194,202,216,222,234,239,244,251,292,298,319,325,330,336,342,348,354,360,371,388,425,436,442,447,452,466],{"__ignoreMap":99},[103,104,107],"span",{"class":105,"line":106},"line",1,[103,108,110],{"class":109},"sJ8bj","# src\u002Fmytool\u002Fcli.py\n",[103,112,114,118],{"class":105,"line":113},2,[103,115,117],{"class":116},"szBVR","import",[103,119,121],{"class":120},"sVt8B"," click\n",[103,123,125,128,131,133],{"class":105,"line":124},3,[103,126,127],{"class":116},"from",[103,129,130],{"class":120}," click.shell_completion ",[103,132,117],{"class":116},[103,134,135],{"class":120}," get_completion_class\n",[103,137,139],{"class":105,"line":138},4,[103,140,142],{"emptyLinePlaceholder":141},true,"\n",[103,144,146],{"class":105,"line":145},5,[103,147,142],{"emptyLinePlaceholder":141},[103,149,151,155],{"class":105,"line":150},6,[103,152,154],{"class":153},"sScJk","@click.group",[103,156,157],{"class":120},"()\n",[103,159,161,164,167,170,174],{"class":105,"line":160},7,[103,162,163],{"class":116},"def",[103,165,166],{"class":153}," cli",[103,168,169],{"class":120},"() -> ",[103,171,173],{"class":172},"sj4cs","None",[103,175,176],{"class":120},":\n",[103,178,180],{"class":105,"line":179},8,[103,181,183],{"class":182},"sZZnC","    \"\"\"My tool.\"\"\"\n",[103,185,187],{"class":105,"line":186},9,[103,188,142],{"emptyLinePlaceholder":141},[103,190,192],{"class":105,"line":191},10,[103,193,142],{"emptyLinePlaceholder":141},[103,195,197,200],{"class":105,"line":196},11,[103,198,199],{"class":153},"@cli.command",[103,201,157],{"class":120},[103,203,205,207,210,212,214],{"class":105,"line":204},12,[103,206,163],{"class":116},[103,208,209],{"class":153}," status",[103,211,169],{"class":120},[103,213,173],{"class":172},[103,215,176],{"class":120},[103,217,219],{"class":105,"line":218},13,[103,220,221],{"class":182},"    \"\"\"Show status.\"\"\"\n",[103,223,225,228,231],{"class":105,"line":224},14,[103,226,227],{"class":120},"    click.echo(",[103,229,230],{"class":182},"\"ok\"",[103,232,233],{"class":120},")\n",[103,235,237],{"class":105,"line":236},15,[103,238,142],{"emptyLinePlaceholder":141},[103,240,242],{"class":105,"line":241},16,[103,243,142],{"emptyLinePlaceholder":141},[103,245,247,249],{"class":105,"line":246},17,[103,248,199],{"class":153},[103,250,157],{"class":120},[103,252,254,257,260,263,266,270,273,276,279,281,284,286,289],{"class":105,"line":253},18,[103,255,256],{"class":153},"@click.argument",[103,258,259],{"class":120},"(",[103,261,262],{"class":182},"\"shell\"",[103,264,265],{"class":120},", ",[103,267,269],{"class":268},"s4XuR","type",[103,271,272],{"class":116},"=",[103,274,275],{"class":120},"click.Choice([",[103,277,278],{"class":182},"\"bash\"",[103,280,265],{"class":120},[103,282,283],{"class":182},"\"zsh\"",[103,285,265],{"class":120},[103,287,288],{"class":182},"\"fish\"",[103,290,291],{"class":120},"]))\n",[103,293,295],{"class":105,"line":294},19,[103,296,297],{"class":153},"@click.pass_context\n",[103,299,301,303,306,309,312,315,317],{"class":105,"line":300},20,[103,302,163],{"class":116},[103,304,305],{"class":153}," completion",[103,307,308],{"class":120},"(ctx: click.Context, shell: ",[103,310,311],{"class":172},"str",[103,313,314],{"class":120},") -> ",[103,316,173],{"class":172},[103,318,176],{"class":120},[103,320,322],{"class":105,"line":321},21,[103,323,324],{"class":182},"    \"\"\"Print the completion script for SHELL.\n",[103,326,328],{"class":105,"line":327},22,[103,329,142],{"emptyLinePlaceholder":141},[103,331,333],{"class":105,"line":332},23,[103,334,335],{"class":172},"    \\b\n",[103,337,339],{"class":105,"line":338},24,[103,340,341],{"class":182},"    bash:  mytool completion bash > ~\u002F.local\u002Fshare\u002Fbash-completion\u002Fcompletions\u002Fmytool\n",[103,343,345],{"class":105,"line":344},25,[103,346,347],{"class":182},"    zsh:   mytool completion zsh > \"${fpath[1]}\u002F_mytool\"\n",[103,349,351],{"class":105,"line":350},26,[103,352,353],{"class":182},"    fish:  mytool completion fish > ~\u002F.config\u002Ffish\u002Fcompletions\u002Fmytool.fish\n",[103,355,357],{"class":105,"line":356},27,[103,358,359],{"class":182},"    \"\"\"\n",[103,361,363,366,368],{"class":105,"line":362},28,[103,364,365],{"class":120},"    root ",[103,367,272],{"class":116},[103,369,370],{"class":120}," ctx.find_root()\n",[103,372,374,377,379,382,385],{"class":105,"line":373},29,[103,375,376],{"class":120},"    prog ",[103,378,272],{"class":116},[103,380,381],{"class":120}," root.info_name ",[103,383,384],{"class":116},"or",[103,386,387],{"class":182}," \"mytool\"\n",[103,389,391,394,396,399,402,405,408,411,413,416,419,422],{"class":105,"line":390},30,[103,392,393],{"class":120},"    complete_var ",[103,395,272],{"class":116},[103,397,398],{"class":116}," f",[103,400,401],{"class":182},"\"_",[103,403,404],{"class":172},"{",[103,406,407],{"class":120},"prog.replace(",[103,409,410],{"class":182},"'-'",[103,412,265],{"class":120},[103,414,415],{"class":182},"'_'",[103,417,418],{"class":120},").upper()",[103,420,421],{"class":172},"}",[103,423,424],{"class":182},"_COMPLETE\"\n",[103,426,428,431,433],{"class":105,"line":427},31,[103,429,430],{"class":120},"    script_class ",[103,432,272],{"class":116},[103,434,435],{"class":120}," get_completion_class(shell)\n",[103,437,439],{"class":105,"line":438},32,[103,440,441],{"class":120},"    click.echo(script_class(root.command, {}, prog, complete_var).source())\n",[103,443,445],{"class":105,"line":444},33,[103,446,142],{"emptyLinePlaceholder":141},[103,448,450],{"class":105,"line":449},34,[103,451,142],{"emptyLinePlaceholder":141},[103,453,455,457,460,462,464],{"class":105,"line":454},35,[103,456,163],{"class":116},[103,458,459],{"class":153}," main",[103,461,169],{"class":120},[103,463,173],{"class":172},[103,465,176],{"class":120},[103,467,469,472,475,477,480],{"class":105,"line":468},36,[103,470,471],{"class":120},"    cli(",[103,473,474],{"class":268},"prog_name",[103,476,272],{"class":116},[103,478,479],{"class":182},"\"mytool\"",[103,481,233],{"class":120},[10,483,484,485,488,489,492,493,496,497,500,501,504,505,28],{},"The command derives the program name and the completion environment variable the same way Click does (",[14,486,487],{},"_MYTOOL_COMPLETE"," for ",[14,490,491],{},"mytool","), so the generated script calls the installed command back correctly. The help text doubles as installation instructions. With Typer, the equivalent output is available without writing a command: ",[14,494,495],{},"mytool --show-completion bash"," prints the script, and ",[14,498,499],{},"_MYTOOL_COMPLETE=source_bash mytool"," does the same for automation. For argparse with argcomplete, ",[14,502,503],{},"register-python-argcomplete mytool"," plays this role, as in ",[19,506,508],{"href":507},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fargcomplete-for-argparse-clis\u002F","tab completion for argparse CLIs with argcomplete",[83,510,512],{"id":511},"lazy-loaded-user-directories","Lazy-loaded user directories",[10,514,515,516,519,520,524],{},"Rather than ",[14,517,518],{},"eval \"$(mytool completion bash)\""," in a shell profile — which runs your CLI on every new shell — save the script once into the directory each shell loads completion files from ",[521,522,523],"em",{},"on demand",":",[35,526,527,539,569],{},[38,528,529,532,533,536,537,28],{},[60,530,531],{},"bash"," (with the bash-completion package, version 2): ",[14,534,535],{},"~\u002F.local\u002Fshare\u002Fbash-completion\u002Fcompletions\u002Fmytool"," — loaded the first time you press Tab after typing ",[14,538,491],{},[38,540,541,544,545,548,549,552,553,556,557,560,561,564,565,568],{},[60,542,543],{},"zsh",": a file named ",[14,546,547],{},"_mytool"," in any directory on ",[14,550,551],{},"$fpath"," (create ",[14,554,555],{},"~\u002F.zfunc",", add it to ",[14,558,559],{},"fpath"," before ",[14,562,563],{},"compinit"," in ",[14,566,567],{},"~\u002F.zshrc",").",[38,570,571,574,575,578],{},[60,572,573],{},"fish",": ",[14,576,577],{},"~\u002F.config\u002Ffish\u002Fcompletions\u002Fmytool.fish"," — loaded automatically.",[10,580,581],{},"Saved files start new shells instantly. The trade-off is that they must be regenerated if the script format changes, which happens rarely; regenerating after major upgrades of the CLI is a good habit to document.",[53,583],{"name":584},"ship-completion-terminal",[83,586,588],{"id":587},"static-scripts-for-package-managers","Static scripts for package managers",[10,590,591],{},"Packages built by Homebrew or distribution tooling can install completion files into system directories, so completion works immediately after installation. Generate the files from the CLI at build time instead of maintaining them by hand. Homebrew's formula DSL has a helper for exactly this:",[94,593,597],{"className":594,"code":595,"language":596,"meta":99,"style":99},"language-ruby shiki shiki-themes github-light github-dark","# Formula\u002Fmytool.rb (excerpt)\ndef install\n  virtualenv_install_with_resources\n  generate_completions_from_executable(bin\u002F\"mytool\", \"completion\")\nend\n","ruby",[14,598,599,604,609,614,619],{"__ignoreMap":99},[103,600,601],{"class":105,"line":106},[103,602,603],{},"# Formula\u002Fmytool.rb (excerpt)\n",[103,605,606],{"class":105,"line":113},[103,607,608],{},"def install\n",[103,610,611],{"class":105,"line":124},[103,612,613],{},"  virtualenv_install_with_resources\n",[103,615,616],{"class":105,"line":138},[103,617,618],{},"  generate_completions_from_executable(bin\u002F\"mytool\", \"completion\")\n",[103,620,621],{"class":105,"line":145},[103,622,623],{},"end\n",[10,625,626,629,630,633,634,265,636,638,639,642,643,646,647,265,650,653,654,657,658,28],{},[14,627,628],{},"generate_completions_from_executable"," runs ",[14,631,632],{},"mytool completion bash"," (and ",[14,635,543],{},[14,637,573],{},") and installs the output where Homebrew's shells look. For ",[14,640,641],{},".deb"," or ",[14,644,645],{},".rpm"," packages, run the same three commands in the build script and install the results to ",[14,648,649],{},"\u002Fusr\u002Fshare\u002Fbash-completion\u002Fcompletions\u002Fmytool",[14,651,652],{},"\u002Fusr\u002Fshare\u002Fzsh\u002Fvendor-completions\u002F_mytool"," (Debian; other distributions use ",[14,655,656],{},"site-functions",") and ",[14,659,660],{},"\u002Fusr\u002Fshare\u002Ffish\u002Fvendor_completions.d\u002Fmytool.fish",[83,662,664],{"id":663},"completion-files-as-release-assets","Completion files as release assets",[10,666,667],{},"For standalone binaries and for packagers who build from your releases, attach generated completion files to each release. A short script run in the release workflow produces them from the freshly built CLI:",[94,669,672],{"className":670,"code":671,"language":531,"meta":99,"style":99},"language-bash shiki shiki-themes github-light github-dark","#!\u002Fusr\u002Fbin\u002Fenv bash\n# scripts\u002Fbuild-completions.sh — run after installing the built wheel or binary\nset -euo pipefail\nout=dist\u002Fcompletions\nmkdir -p \"$out\"\nmytool completion bash > \"$out\u002Fmytool.bash\"\nmytool completion zsh  > \"$out\u002F_mytool\"\nmytool completion fish > \"$out\u002Fmytool.fish\"\ntar -czf dist\u002Fmytool-completions.tar.gz -C dist completions\n",[14,673,674,679,684,695,705,722,741,760,778],{"__ignoreMap":99},[103,675,676],{"class":105,"line":106},[103,677,678],{"class":109},"#!\u002Fusr\u002Fbin\u002Fenv bash\n",[103,680,681],{"class":105,"line":113},[103,682,683],{"class":109},"# scripts\u002Fbuild-completions.sh — run after installing the built wheel or binary\n",[103,685,686,689,692],{"class":105,"line":124},[103,687,688],{"class":172},"set",[103,690,691],{"class":172}," -euo",[103,693,694],{"class":182}," pipefail\n",[103,696,697,700,702],{"class":105,"line":138},[103,698,699],{"class":120},"out",[103,701,272],{"class":116},[103,703,704],{"class":182},"dist\u002Fcompletions\n",[103,706,707,710,713,716,719],{"class":105,"line":145},[103,708,709],{"class":153},"mkdir",[103,711,712],{"class":172}," -p",[103,714,715],{"class":182}," \"",[103,717,718],{"class":120},"$out",[103,720,721],{"class":182},"\"\n",[103,723,724,726,728,731,734,736,738],{"class":105,"line":150},[103,725,491],{"class":153},[103,727,305],{"class":182},[103,729,730],{"class":182}," bash",[103,732,733],{"class":116}," >",[103,735,715],{"class":182},[103,737,718],{"class":120},[103,739,740],{"class":182},"\u002Fmytool.bash\"\n",[103,742,743,745,747,750,753,755,757],{"class":105,"line":160},[103,744,491],{"class":153},[103,746,305],{"class":182},[103,748,749],{"class":182}," zsh",[103,751,752],{"class":116},"  >",[103,754,715],{"class":182},[103,756,718],{"class":120},[103,758,759],{"class":182},"\u002F_mytool\"\n",[103,761,762,764,766,769,771,773,775],{"class":105,"line":179},[103,763,491],{"class":153},[103,765,305],{"class":182},[103,767,768],{"class":182}," fish",[103,770,733],{"class":116},[103,772,715],{"class":182},[103,774,718],{"class":120},[103,776,777],{"class":182},"\u002Fmytool.fish\"\n",[103,779,780,783,786,789,792,795],{"class":105,"line":186},[103,781,782],{"class":153},"tar",[103,784,785],{"class":172}," -czf",[103,787,788],{"class":182}," dist\u002Fmytool-completions.tar.gz",[103,790,791],{"class":172}," -C",[103,793,794],{"class":182}," dist",[103,796,797],{"class":182}," completions\n",[10,799,800],{},"Generating from the built artefact, rather than from the source tree, guarantees that the scripts match the version being released, and packagers for distributions you do not maintain yourself — Arch's AUR, Nix, community Scoop buckets — can install them without running your CLI during their build. Because the scripts only connect the shell to the program, the same files keep working across minor releases; regenerating them with every release simply keeps everything in step.",[30,802,804],{"id":803},"ux-considerations","UX considerations",[35,806,807,813,826,834,845],{},[38,808,809,812],{},[60,810,811],{},"Make the first step one line."," The README should show a single command per shell. Anything longer is skipped.",[38,814,815,821,822,825],{},[60,816,817,818,28],{},"Prefer saved files to ",[14,819,820],{},"eval"," Every ",[14,823,824],{},"eval \"$(mytool …)\""," adds your startup time to every new shell; files are loaded lazily.",[38,827,828,833],{},[60,829,830,831,28],{},"Be careful with ",[14,832,68],{}," It is convenient, but it edits shell configuration files; document what it changes, and offer the subcommand for users who manage their dotfiles themselves.",[38,835,836,839,840,844],{},[60,837,838],{},"Keep completion fast regardless of delivery."," The script only connects the shell to your program; each Tab still runs the CLI, so the advice in ",[19,841,843],{"href":842},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time\u002F","profiling Python CLI startup time"," applies.",[38,846,847,850,851,854],{},[60,848,849],{},"Hide the completion command from casual users"," if it clutters help — ",[14,852,853],{},"hidden=True"," — but mention it in the installation docs.",[53,856],{"name":857},"ship-completion-dirs",[30,859,861],{"id":860},"testing-the-behaviour","Testing the behaviour",[10,863,864],{},"Test that each script is generated, names the right program and environment variable, and — for bash — is syntactically valid:",[94,866,868],{"className":96,"code":867,"language":98,"meta":99,"style":99},"# tests\u002Ftest_completion_scripts.py\nimport shutil\nimport subprocess\n\nimport pytest\nfrom click.testing import CliRunner\n\nfrom mytool.cli import cli\n\nrunner = CliRunner()\n\n\n@pytest.mark.parametrize(\"shell,marker\", [(\"bash\", \"_mytool_completion()\"),\n                                          (\"zsh\", \"#compdef mytool\"),\n                                          (\"fish\", \"function _mytool_completion\")])\ndef test_scripts_are_generated(shell, marker):\n    result = runner.invoke(cli, [\"completion\", shell], prog_name=\"mytool\")\n    assert result.exit_code == 0\n    assert marker in result.output\n    assert \"_MYTOOL_COMPLETE\" in result.output\n\n\n@pytest.mark.skipif(shutil.which(\"bash\") is None, reason=\"bash not installed\")\ndef test_bash_script_parses(tmp_path):\n    script = tmp_path \u002F \"mytool.bash\"\n    script.write_text(runner.invoke(cli, [\"completion\", \"bash\"], prog_name=\"mytool\").output)\n    subprocess.run([\"bash\", \"-n\", str(script)], check=True)\n\n\ndef test_unknown_shell_is_a_usage_error():\n    assert runner.invoke(cli, [\"completion\", \"powershell\"]).exit_code == 2\n",[14,869,870,875,882,889,893,900,912,916,928,932,942,946,950,973,987,1001,1011,1035,1049,1062,1074,1078,1082,1113,1123,1139,1162,1191,1195,1199,1209],{"__ignoreMap":99},[103,871,872],{"class":105,"line":106},[103,873,874],{"class":109},"# tests\u002Ftest_completion_scripts.py\n",[103,876,877,879],{"class":105,"line":113},[103,878,117],{"class":116},[103,880,881],{"class":120}," shutil\n",[103,883,884,886],{"class":105,"line":124},[103,885,117],{"class":116},[103,887,888],{"class":120}," subprocess\n",[103,890,891],{"class":105,"line":138},[103,892,142],{"emptyLinePlaceholder":141},[103,894,895,897],{"class":105,"line":145},[103,896,117],{"class":116},[103,898,899],{"class":120}," pytest\n",[103,901,902,904,907,909],{"class":105,"line":150},[103,903,127],{"class":116},[103,905,906],{"class":120}," click.testing ",[103,908,117],{"class":116},[103,910,911],{"class":120}," CliRunner\n",[103,913,914],{"class":105,"line":160},[103,915,142],{"emptyLinePlaceholder":141},[103,917,918,920,923,925],{"class":105,"line":179},[103,919,127],{"class":116},[103,921,922],{"class":120}," mytool.cli ",[103,924,117],{"class":116},[103,926,927],{"class":120}," cli\n",[103,929,930],{"class":105,"line":186},[103,931,142],{"emptyLinePlaceholder":141},[103,933,934,937,939],{"class":105,"line":191},[103,935,936],{"class":120},"runner ",[103,938,272],{"class":116},[103,940,941],{"class":120}," CliRunner()\n",[103,943,944],{"class":105,"line":196},[103,945,142],{"emptyLinePlaceholder":141},[103,947,948],{"class":105,"line":204},[103,949,142],{"emptyLinePlaceholder":141},[103,951,952,955,957,960,963,965,967,970],{"class":105,"line":218},[103,953,954],{"class":153},"@pytest.mark.parametrize",[103,956,259],{"class":120},[103,958,959],{"class":182},"\"shell,marker\"",[103,961,962],{"class":120},", [(",[103,964,278],{"class":182},[103,966,265],{"class":120},[103,968,969],{"class":182},"\"_mytool_completion()\"",[103,971,972],{"class":120},"),\n",[103,974,975,978,980,982,985],{"class":105,"line":224},[103,976,977],{"class":120},"                                          (",[103,979,283],{"class":182},[103,981,265],{"class":120},[103,983,984],{"class":182},"\"#compdef mytool\"",[103,986,972],{"class":120},[103,988,989,991,993,995,998],{"class":105,"line":236},[103,990,977],{"class":120},[103,992,288],{"class":182},[103,994,265],{"class":120},[103,996,997],{"class":182},"\"function _mytool_completion\"",[103,999,1000],{"class":120},")])\n",[103,1002,1003,1005,1008],{"class":105,"line":241},[103,1004,163],{"class":116},[103,1006,1007],{"class":153}," test_scripts_are_generated",[103,1009,1010],{"class":120},"(shell, marker):\n",[103,1012,1013,1016,1018,1021,1024,1027,1029,1031,1033],{"class":105,"line":246},[103,1014,1015],{"class":120},"    result ",[103,1017,272],{"class":116},[103,1019,1020],{"class":120}," runner.invoke(cli, [",[103,1022,1023],{"class":182},"\"completion\"",[103,1025,1026],{"class":120},", shell], ",[103,1028,474],{"class":268},[103,1030,272],{"class":116},[103,1032,479],{"class":182},[103,1034,233],{"class":120},[103,1036,1037,1040,1043,1046],{"class":105,"line":253},[103,1038,1039],{"class":116},"    assert",[103,1041,1042],{"class":120}," result.exit_code ",[103,1044,1045],{"class":116},"==",[103,1047,1048],{"class":172}," 0\n",[103,1050,1051,1053,1056,1059],{"class":105,"line":294},[103,1052,1039],{"class":116},[103,1054,1055],{"class":120}," marker ",[103,1057,1058],{"class":116},"in",[103,1060,1061],{"class":120}," result.output\n",[103,1063,1064,1066,1069,1072],{"class":105,"line":300},[103,1065,1039],{"class":116},[103,1067,1068],{"class":182}," \"_MYTOOL_COMPLETE\"",[103,1070,1071],{"class":116}," in",[103,1073,1061],{"class":120},[103,1075,1076],{"class":105,"line":321},[103,1077,142],{"emptyLinePlaceholder":141},[103,1079,1080],{"class":105,"line":327},[103,1081,142],{"emptyLinePlaceholder":141},[103,1083,1084,1087,1090,1092,1095,1098,1101,1103,1106,1108,1111],{"class":105,"line":332},[103,1085,1086],{"class":153},"@pytest.mark.skipif",[103,1088,1089],{"class":120},"(shutil.which(",[103,1091,278],{"class":182},[103,1093,1094],{"class":120},") ",[103,1096,1097],{"class":116},"is",[103,1099,1100],{"class":172}," None",[103,1102,265],{"class":120},[103,1104,1105],{"class":268},"reason",[103,1107,272],{"class":116},[103,1109,1110],{"class":182},"\"bash not installed\"",[103,1112,233],{"class":120},[103,1114,1115,1117,1120],{"class":105,"line":338},[103,1116,163],{"class":116},[103,1118,1119],{"class":153}," test_bash_script_parses",[103,1121,1122],{"class":120},"(tmp_path):\n",[103,1124,1125,1128,1130,1133,1136],{"class":105,"line":344},[103,1126,1127],{"class":120},"    script ",[103,1129,272],{"class":116},[103,1131,1132],{"class":120}," tmp_path ",[103,1134,1135],{"class":116},"\u002F",[103,1137,1138],{"class":182}," \"mytool.bash\"\n",[103,1140,1141,1144,1146,1148,1150,1153,1155,1157,1159],{"class":105,"line":350},[103,1142,1143],{"class":120},"    script.write_text(runner.invoke(cli, [",[103,1145,1023],{"class":182},[103,1147,265],{"class":120},[103,1149,278],{"class":182},[103,1151,1152],{"class":120},"], ",[103,1154,474],{"class":268},[103,1156,272],{"class":116},[103,1158,479],{"class":182},[103,1160,1161],{"class":120},").output)\n",[103,1163,1164,1167,1169,1171,1174,1176,1178,1181,1184,1186,1189],{"class":105,"line":356},[103,1165,1166],{"class":120},"    subprocess.run([",[103,1168,278],{"class":182},[103,1170,265],{"class":120},[103,1172,1173],{"class":182},"\"-n\"",[103,1175,265],{"class":120},[103,1177,311],{"class":172},[103,1179,1180],{"class":120},"(script)], ",[103,1182,1183],{"class":268},"check",[103,1185,272],{"class":116},[103,1187,1188],{"class":172},"True",[103,1190,233],{"class":120},[103,1192,1193],{"class":105,"line":362},[103,1194,142],{"emptyLinePlaceholder":141},[103,1196,1197],{"class":105,"line":373},[103,1198,142],{"emptyLinePlaceholder":141},[103,1200,1201,1203,1206],{"class":105,"line":390},[103,1202,163],{"class":116},[103,1204,1205],{"class":153}," test_unknown_shell_is_a_usage_error",[103,1207,1208],{"class":120},"():\n",[103,1210,1211,1213,1215,1217,1219,1222,1225,1227],{"class":105,"line":427},[103,1212,1039],{"class":116},[103,1214,1020],{"class":120},[103,1216,1023],{"class":182},[103,1218,265],{"class":120},[103,1220,1221],{"class":182},"\"powershell\"",[103,1223,1224],{"class":120},"]).exit_code ",[103,1226,1045],{"class":116},[103,1228,1229],{"class":172}," 2\n",[10,1231,1232,1235,1236,28],{},[14,1233,1234],{},"bash -n"," parses the script without running it, which catches the one failure that would otherwise only appear in users' shells: a syntax error introduced by a template change. To test the completions themselves, use the approach in ",[19,1237,1239],{"href":1238},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis\u002F","testing shell completion in Python CLIs",[30,1241,1243],{"id":1242},"conclusion","Conclusion",[10,1245,1246,1247,1250,1251,1254],{},"Completion only helps users who have it installed, so make installation trivial. Add a ",[14,1248,1249],{},"completion SHELL"," subcommand that prints the script using Click's own generator (or Typer's ",[14,1252,1253],{},"--show-completion","), document saving it into the lazily loaded per-user directories, generate static files at release time for Homebrew and Linux packages, and test that every script is generated, references the right program and parses. The result is completion that works the moment someone installs your tool through a package manager — and one line away for everyone else.",[30,1256,1258],{"id":1257},"frequently-asked-questions","Frequently asked questions",[83,1260,1262],{"id":1261},"why-not-ship-the-scripts-inside-the-wheel","Why not ship the scripts inside the wheel?",[10,1264,1265],{},"Wheels can install data files only under the installation prefix. With pipx or uv, that prefix is a private tool environment that shells never read. System packages and Homebrew can place files in shell-specific directories; Python packaging cannot.",[83,1267,1269],{"id":1268},"what-happens-to-completion-after-the-cli-is-upgraded","What happens to completion after the CLI is upgraded?",[10,1271,1272],{},"The script calls the installed command each time, so new commands and options complete immediately. Only changes to the script itself — rare, and tied to the framework — require regenerating saved files.",[83,1274,1276],{"id":1275},"does-powershell-completion-work-the-same-way","Does PowerShell completion work the same way?",[10,1278,1279,1280,1282,1283,1286],{},"Not with Click's generator, which supports bash, zsh and fish. Typer's ",[14,1281,68],{}," supports PowerShell; for Click, a small ",[14,1284,1285],{},"Register-ArgumentCompleter"," script that calls the program with Click's completion environment variables is the usual approach.",[83,1288,1290],{"id":1289},"can-the-completion-subcommand-install-the-file-itself","Can the completion subcommand install the file itself?",[10,1292,1293,1294,1297],{},"It can — write to the per-user directory when given ",[14,1295,1296],{},"--install"," — and many CLIs do. Print the path you wrote and how to undo it, and never overwrite a file you did not create without asking.",[83,1299,1301],{"id":1300},"how-do-i-know-whether-users-actually-have-completion-installed","How do I know whether users actually have completion installed?",[10,1303,1304,1305,1308,1309,1312],{},"You usually cannot, and should not try to detect it at runtime. A gentle nudge works better: mention ",[14,1306,1307],{},"mytool completion --help"," in the output of ",[14,1310,1311],{},"mytool --version --verbose"," or in the first-run message, and keep the README's one-liner prominent.",[30,1314,1316],{"id":1315},"related","Related",[35,1318,1319,1325,1330,1336,1341],{},[38,1320,1321,1322],{},"Up: ",[19,1323,1324],{"href":21},"Shell completion for Python CLIs",[38,1326,1327],{},[19,1328,1329],{"href":26},"Enabling tab completion in Click and Typer",[38,1331,1332],{},[19,1333,1335],{"href":1334},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Finstalling-shell-completion-for-bash-zsh-fish\u002F","Installing shell completion for bash, zsh and fish",[38,1337,1338],{},[19,1339,1340],{"href":507},"Tab completion for argparse CLIs with argcomplete",[38,1342,1343],{},[19,1344,47],{"href":46},[1346,1347,1348],"style",{},"html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}html pre.shiki code .szBVR, html code.shiki .szBVR{--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html pre.shiki code .s4XuR, html code.shiki .s4XuR{--shiki-default:#E36209;--shiki-dark:#FFAB70}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":99,"searchDepth":113,"depth":113,"links":1350},[1351,1352,1353,1360,1361,1362,1363,1370],{"id":32,"depth":113,"text":33},{"id":50,"depth":113,"text":51},{"id":80,"depth":113,"text":81,"children":1354},[1355,1357,1358,1359],{"id":85,"depth":124,"text":1356},"A completion subcommand",{"id":511,"depth":124,"text":512},{"id":587,"depth":124,"text":588},{"id":663,"depth":124,"text":664},{"id":803,"depth":113,"text":804},{"id":860,"depth":113,"text":861},{"id":1242,"depth":113,"text":1243},{"id":1257,"depth":113,"text":1258,"children":1364},[1365,1366,1367,1368,1369],{"id":1261,"depth":124,"text":1262},{"id":1268,"depth":124,"text":1269},{"id":1275,"depth":124,"text":1276},{"id":1289,"depth":124,"text":1290},{"id":1300,"depth":124,"text":1301},{"id":1315,"depth":113,"text":1316},"2026-10-02","Get completion to users without manual setup: a completion subcommand, lazy-loaded user directories, static scripts generated at release time for Homebrew and Linux packages, and tests.","intermediate",false,"md",{},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages",{"title":5,"description":1372},"advanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages\u002Findex",[16,1381,1382,531,543],"packaging","homebrew","XoGVs8GDtdncFRqQtSKDFJ39OM6ZDfzONIoBxFLtbJQ",[1385,1388,1391,1394,1397,1400,1403,1406,1409,1412,1415,1418,1421,1424,1427,1430,1433,1436,1439,1442,1445,1448,1451,1454,1457,1460,1463,1466,1469,1472,1475,1478,1481,1484,1487,1490,1493,1496,1499,1502,1505,1508,1511,1514,1517,1520,1523,1526,1529,1532,1535,1538,1541,1544,1547,1550,1553,1556,1559,1562,1565,1568,1571,1574,1577,1580,1581,1584,1587,1590,1593,1596,1599,1602,1605,1608,1611,1614,1617,1620,1623,1626,1629,1632,1635,1638,1641,1644,1647,1650,1653,1656,1659,1662,1665,1668,1671,1674,1677,1680,1683,1686,1689,1692,1695,1698,1701,1704,1707,1710,1713,1716,1719,1722,1725,1728,1731,1734,1737,1740,1743,1746,1749,1752,1755,1758,1761,1764,1767,1770,1773,1776,1779,1782,1785,1788,1791,1794,1797,1800,1802,1805,1808,1811,1814,1817,1820,1823,1826,1829,1832,1835,1838,1841,1844,1847,1850,1853,1856,1859,1862,1865,1868,1871,1874,1877,1880,1883,1886,1889,1892,1895,1898,1901,1904,1907,1910,1913,1916,1919,1922,1925,1928,1931,1934,1937,1940,1943,1946,1949,1952,1955,1958,1961,1964,1967,1970,1973,1976,1979,1982,1985,1988,1991,1994,1997,2000,2003,2006,2009,2012,2015,2018,2021,2024,2027,2030,2033,2036,2039,2042,2045,2048,2051,2054,2057,2060,2063,2066,2069,2072,2075,2078,2081,2084,2087,2090,2093,2096,2099,2102,2105,2108,2111,2114,2117,2120,2123,2126,2129,2132,2135,2138,2141,2144,2147,2150,2153,2156,2159,2162,2165,2168,2171,2174,2177,2180,2183,2186,2189,2192,2195,2198,2201,2204,2207,2210,2213,2216,2219,2222,2225],{"path":1386,"title":1387},"\u002Fabout","About Python CLI Toolcraft",{"path":1389,"title":1390},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":1392,"title":1393},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":1395,"title":1396},"\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":1398,"title":1399},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":1401,"title":1402},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":1404,"title":1405},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-urls-hosts-and-ports","Validating URLs, Hosts and Ports in Python CLI Arguments",{"path":1407,"title":1408},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":1410,"title":1411},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbrowsing-records-with-a-textual-datatable","Browsing Records with a Textual DataTable Picker",{"path":1413,"title":1414},"\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":1416,"title":1417},"\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":1419,"title":1420},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":1422,"title":1423},"\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":1425,"title":1426},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fstyling-textual-apps-with-tcss","Styling Textual Apps with TCSS",{"path":1428,"title":1429},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":1431,"title":1432},"\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":1434,"title":1435},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fdocumenting-environment-variables-in-help","Documenting Environment Variables in CLI Help",{"path":1437,"title":1438},"\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":1440,"title":1441},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":1443,"title":1444},"\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":1446,"title":1447},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":1449,"title":1450},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":1452,"title":1453},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":1455,"title":1456},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":1458,"title":1459},"\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":1461,"title":1462},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fhandling-ansi-escape-codes-on-windows-consoles","Handling ANSI Escape Codes on Windows Consoles",{"path":1464,"title":1465},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":1467,"title":1468},"\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":1470,"title":1471},"\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":1473,"title":1474},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":1476,"title":1477},"\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":1479,"title":1480},"\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":1482,"title":1483},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":1485,"title":1486},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":1488,"title":1489},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":1491,"title":1492},"\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":1494,"title":1495},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fwriting-crash-reports-users-can-send","Writing Crash Reports Users Can Send",{"path":1497,"title":1498},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":1500,"title":1501},"\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":1503,"title":1504},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":1506,"title":1507},"\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":1509,"title":1510},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":1512,"title":1513},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":1515,"title":1516},"\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":1518,"title":1519},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fwriting-a-config-init-and-edit-command","Writing a Config Init and Edit Command for a Python CLI",{"path":1521,"title":1522},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":1524,"title":1525},"\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":1527,"title":1528},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":1530,"title":1531},"\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":1533,"title":1534},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":1536,"title":1537},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":1539,"title":1540},"\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":1542,"title":1543},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":1545,"title":1546},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":1548,"title":1549},"\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":1551,"title":1552},"\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":1554,"title":1555},"\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":1557,"title":1558},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis","Output Formats for Data-Heavy Python CLIs",{"path":1560,"title":1561},"\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":1563,"title":1564},"\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":1566,"title":1567},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fargcomplete-for-argparse-clis","Tab Completion for argparse CLIs with argcomplete",{"path":1569,"title":1570},"\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":1572,"title":1573},"\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":1575,"title":1576},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":1578,"title":1579},"\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":1377,"title":5},{"path":1582,"title":1583},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":1585,"title":1586},"\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":1588,"title":1589},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":1591,"title":1592},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":1594,"title":1595},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Flogging-with-structlog-in-a-cli","Logging with structlog in a Python CLI",{"path":1597,"title":1598},"\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":1600,"title":1601},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":1603,"title":1604},"\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":1606,"title":1607},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":1609,"title":1610},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":1612,"title":1613},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":1615,"title":1616},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":1618,"title":1619},"\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":1621,"title":1622},"\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":1624,"title":1625},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":1627,"title":1628},"\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":1630,"title":1631},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":1633,"title":1634},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":1636,"title":1637},"\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":1639,"title":1640},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":1642,"title":1643},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":1645,"title":1646},"\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":1648,"title":1649},"\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":1651,"title":1652},"\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":1654,"title":1655},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":1657,"title":1658},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":1660,"title":1661},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":1663,"title":1664},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":1666,"title":1667},"\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":1669,"title":1670},"\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":1672,"title":1673},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fstructured-concurrency-with-taskgroups-in-clis","Structured Concurrency with TaskGroups in Python CLIs",{"path":1675,"title":1676},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":1678,"title":1679},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":1681,"title":1682},"\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":1684,"title":1685},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":1687,"title":1688},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":1690,"title":1691},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":1693,"title":1694},"\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":1696,"title":1697},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":1699,"title":1700},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":1702,"title":1703},"\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":1705,"title":1706},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis","Local State and SQLite in Python CLIs",{"path":1708,"title":1709},"\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":1711,"title":1712},"\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":1714,"title":1715},"\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":1717,"title":1718},"\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":1720,"title":1721},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":1723,"title":1724},"\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":1726,"title":1727},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":1729,"title":1730},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Freloading-config-on-sighup","Reloading Configuration on SIGHUP in a Python CLI",{"path":1732,"title":1733},"\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":1735,"title":1736},"\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":1738,"title":1739},"\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":1741,"title":1742},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":1744,"title":1745},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":1747,"title":1748},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":1750,"title":1751},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":1753,"title":1754},"\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":1756,"title":1757},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fpiping-between-subprocesses-in-python","Piping Between Subprocesses in Python Without a Shell",{"path":1759,"title":1760},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":1762,"title":1763},"\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":1765,"title":1766},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":1768,"title":1769},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":1771,"title":1772},"\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":1774,"title":1775},"\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":1777,"title":1778},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Frefreshing-expired-tokens-automatically","Refreshing Expired Tokens Automatically in a Python CLI",{"path":1780,"title":1781},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":1783,"title":1784},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":1786,"title":1787},"\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":1789,"title":1790},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis","Update Checks, Upgrade Commands and Telemetry for Python CLIs",{"path":1792,"title":1793},"\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":1795,"title":1796},"\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":1798,"title":1799},"\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":1135,"title":1801},"Python CLI Toolcraft",{"path":1803,"title":1804},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo","Building a Python CLI with Cleo Command Classes",{"path":1806,"title":1807},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts","Building a Type-Hinted Python CLI with Cyclopts",{"path":1809,"title":1810},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks","Beyond Click and Typer: Alternative Python CLI Frameworks",{"path":1812,"title":1813},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fquick-clis-from-functions-with-python-fire","Quick CLIs from Functions with Python Fire",{"path":1815,"title":1816},"\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":1818,"title":1819},"\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":1821,"title":1822},"\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":1824,"title":1825},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fguarding-startup-with-import-tests","Guarding CLI Startup with Import Tests",{"path":1827,"title":1828},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":1830,"title":1831},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":1833,"title":1834},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":1836,"title":1837},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":1839,"title":1840},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":1842,"title":1843},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":1845,"title":1846},"\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":1848,"title":1849},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":1851,"title":1852},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":1854,"title":1855},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":1857,"title":1858},"\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":1860,"title":1861},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":1863,"title":1864},"\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":1866,"title":1867},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fdesigning-idempotent-commands","Designing Idempotent Commands in a Python CLI",{"path":1869,"title":1870},"\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":1872,"title":1873},"\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":1875,"title":1876},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":1878,"title":1879},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":1881,"title":1882},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fpositional-arguments-vs-options","Positional Arguments vs Options: Designing a CLI Signature",{"path":1884,"title":1885},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":1887,"title":1888},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":1890,"title":1891},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":1893,"title":1894},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":1896,"title":1897},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures","Isolating Plugin Failures in an Extensible Python CLI",{"path":1899,"title":1900},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli","Testing Plugins Against the Host CLI",{"path":1902,"title":1903},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":1905,"title":1906},"\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":1908,"title":1909},"\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":1911,"title":1912},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":1914,"title":1915},"\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":1917,"title":1918},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":1920,"title":1921},"\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":1923,"title":1924},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically","Registering CLI Commands from Modules Automatically",{"path":1926,"title":1927},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":1929,"title":1930},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":1932,"title":1933},"\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":1935,"title":1936},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":1938,"title":1939},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":1941,"title":1942},"\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":1944,"title":1945},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":1947,"title":1948},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":1950,"title":1951},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":1953,"title":1954},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-commands-that-call-subprocesses","Testing Python CLI Commands That Call Subprocesses",{"path":1956,"title":1957},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":1959,"title":1960},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands","Transcript Tests for Python CLI Commands",{"path":1962,"title":1963},"\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":1965,"title":1966},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":1968,"title":1969},"\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":1971,"title":1972},"\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":1974,"title":1975},"\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":1977,"title":1978},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":1980,"title":1981},"\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":1983,"title":1984},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":1986,"title":1987},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":1989,"title":1990},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":1992,"title":1993},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":1995,"title":1996},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":1998,"title":1999},"\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":2001,"title":2002},"\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":2004,"title":2005},"\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":2007,"title":2008},"\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":2010,"title":2011},"\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":2013,"title":2014},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":2016,"title":2017},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":2019,"title":2020},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":2022,"title":2023},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":2025,"title":2026},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftemplate-variables-and-conditional-files","Template Variables and Conditional Files in CLI Templates",{"path":2028,"title":2029},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftesting-a-project-template-with-pytest","Testing a CLI Project Template with pytest",{"path":2031,"title":2032},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fupdating-generated-projects-with-copier-update","Updating Generated CLI Projects with copier update",{"path":2034,"title":2035},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":2037,"title":2038},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":2040,"title":2041},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fcode-signing-and-notarizing-cli-binaries","Code Signing and Notarizing Python CLI Binaries",{"path":2043,"title":2044},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":2046,"title":2047},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":2049,"title":2050},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":2052,"title":2053},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Freducing-pyinstaller-binary-size","Reducing the Size of a PyInstaller CLI Binary",{"path":2055,"title":2056},"\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":2058,"title":2059},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":2061,"title":2062},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":2064,"title":2065},"\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":2067,"title":2068},"\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":2070,"title":2071},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":2073,"title":2074},"\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":2076,"title":2077},"\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":2079,"title":2080},"\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":2082,"title":2083},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":2085,"title":2086},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fbumping-versions-consistently-across-a-cli-project","Bumping Versions Consistently Across a Python CLI Project",{"path":2088,"title":2089},"\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":2091,"title":2092},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":2094,"title":2095},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":2097,"title":2098},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":2100,"title":2101},"\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":2103,"title":2104},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":2106,"title":2107},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":2109,"title":2110},"\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":2112,"title":2113},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":2115,"title":2116},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":2118,"title":2119},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Foptional-dependencies-and-extras-for-clis","Optional Dependencies and Extras for Python CLIs",{"path":2121,"title":2122},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":2124,"title":2125},"\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":2127,"title":2128},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fdynamic-versioning-with-poetry-plugins","Dynamic Versioning for a Poetry CLI from Git Tags",{"path":2130,"title":2131},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":2133,"title":2134},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmanaging-poetry-lock-files-for-cli-tools","Managing Poetry Lock Files for CLI Tools",{"path":2136,"title":2137},"\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":2139,"title":2140},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":2142,"title":2143},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":2145,"title":2146},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpublishing-a-cli-with-poetry","Building and Publishing a Python CLI with Poetry",{"path":2148,"title":2149},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":2151,"title":2152},"\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":2154,"title":2155},"\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":2157,"title":2158},"\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":2160,"title":2161},"\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":2163,"title":2164},"\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":2166,"title":2167},"\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":2169,"title":2170},"\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":2172,"title":2173},"\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":2175,"title":2176},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain","Securing the Supply Chain of a Python CLI",{"path":2178,"title":2179},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpinning-dependencies-with-hashes","Pinning a Python CLI’s Dependencies with Hashes",{"path":2181,"title":2182},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpublishing-attestations-and-verifying-releases","Publishing Attestations and Verifying Python CLI Releases",{"path":2184,"title":2185},"\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":2187,"title":2188},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":2190,"title":2191},"\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":2193,"title":2194},"\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":2196,"title":2197},"\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":2199,"title":2200},"\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":2202,"title":2203},"\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":2205,"title":2206},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":2208,"title":2209},"\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":2211,"title":2212},"\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":2214,"title":2215},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":2217,"title":2218},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fisolating-cli-tools-from-project-dependencies","Isolating CLI Tools from Your Project’s Dependencies",{"path":2220,"title":2221},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":2223,"title":2224},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":2226,"title":2227},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1790967537216]