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