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