mirror of https://github.com/pypa/hatch.git
79 lines
114 KiB
HTML
79 lines
114 KiB
HTML
<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="Modern, extensible Python project management"><meta name=author content="Ofek Lev"><link href=https://hatch.pypa.io/1.12/cli/reference/ rel=canonical><link href=../about/ rel=prev><link href=../../plugins/about/ rel=next><link rel=icon href=../../assets/images/logo.svg><meta name=generator content="mkdocs-1.6.0, mkdocs-material-9.5.24+insiders-4.53.10"><title>Reference - Hatch</title><link rel=stylesheet href=../../assets/stylesheets/main.c0d16a3a.min.css><link rel=stylesheet href=../../assets/stylesheets/palette.ab4e12ef.min.css><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><link rel=stylesheet href=../../assets/_mkdocstrings.css><link rel=stylesheet href=../../assets/css/custom.css><link rel=stylesheet href=https://cdn.jsdelivr.net/npm/firacode@6.2.0/distr/fira_code.css><script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script><meta property=og:type content=website><meta property=og:title content="Reference - Hatch"><meta property=og:description content="Modern, extensible Python project management"><meta property=og:image content=https://hatch.pypa.io/1.12/assets/images/social/cli/reference.png><meta property=og:image:type content=image/png><meta property=og:image:width content=1200><meta property=og:image:height content=630><meta content=https://hatch.pypa.io/1.12/cli/reference/ property=og:url><meta property=twitter:card content=summary_large_image><meta property=twitter:title content="Reference - Hatch"><meta property=twitter:description content="Modern, extensible Python project management"><meta property=twitter:image content=https://hatch.pypa.io/1.12/assets/images/social/cli/reference.png><link href=../../assets/stylesheets/glightbox.min.css rel=stylesheet><style>
|
|
html.glightbox-open { overflow: initial; height: 100%; }
|
|
.gslide-title { margin-top: 0px; user-select: text; }
|
|
.gslide-desc { color: #666; user-select: text; }
|
|
.gslide-image img { background: white; }
|
|
.gscrollbar-fixer { padding-right: 15px; }
|
|
.gdesc-inner { font-size: 0.75rem; }
|
|
body[data-md-color-scheme="slate"] .gdesc-inner { background: var(--md-default-bg-color);}
|
|
body[data-md-color-scheme="slate"] .gslide-title { color: var(--md-default-fg-color);}
|
|
body[data-md-color-scheme="slate"] .gslide-desc { color: var(--md-default-fg-color);}</style><script src=../../assets/javascripts/glightbox.min.js></script></head> <body dir=ltr data-md-color-scheme=slate data-md-color-primary=indigo data-md-color-accent=indigo> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#hatch class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <div data-md-color-scheme=default data-md-component=outdated hidden> </div> <header class="md-header md-header--shadow md-header--lifted" data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Header> <a href=../.. title=Hatch class="md-header__button md-logo" aria-label=Hatch data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19.5 14.5A7.5 7.5 0 0 1 12 22a7.5 7.5 0 0 1-7.5-7.5C4.5 10.36 7.86 2 12 2c4.14 0 7.5 8.36 7.5 12.5Z"/></svg> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> Hatch </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> Reference </span> </div> </div> </div> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme=slate data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to light mode" type=radio name=__palette id=__palette_0> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31Z"/></svg> </label> <input class=md-option data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to dark mode" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_0 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5c-.84 0-1.65.15-2.39.42L12 2M3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29L3.34 7m.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14L3.36 17M20.65 7l-1.77 3.79a7.023 7.023 0 0 0-2.38-4.15l4.15.36m-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29L20.64 17M12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44L12 22Z"/></svg> </label> </form> <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script> <label class="md-header__button md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg> </label> <div class=md-search data-md-component=search role=dialog> <label class=md-search__overlay for=__search></label> <div class=md-search__inner role=search> <form class=md-search__form name=search> <input type=text class=md-search__input name=query aria-label=Search placeholder=Search autocapitalize=off autocorrect=off autocomplete=off spellcheck=false data-md-component=search-query required> <label class="md-search__icon md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> </label> <nav class=md-search__options aria-label=Search> <button type=reset class="md-search__icon md-icon" title=Clear aria-label=Clear tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg> </button> </nav> </form> <div class=md-search__output> <div class=md-search__scrollwrap data-md-scrollfix> <div class=md-search-result data-md-component=search-result> <div class=md-search-result__meta> Initializing search </div> <ol class=md-search-result__list role=presentation></ol> </div> </div> </div> </div> </div> <div class=md-header__source> <a href=https://github.com/pypa/hatch title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 480 512"><!-- Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"/></svg> </div> <div class=md-source__repository> pypa/hatch </div> </a> </div> </nav> <nav class=md-tabs aria-label=Tabs data-md-component=tabs> <div class=md-grid> <ul class=md-tabs__list> <li class=md-tabs__item> <a href=../.. class=md-tabs__link> Home </a> </li> <li class=md-tabs__item> <a href=../../config/metadata/ class=md-tabs__link> Configuration </a> </li> <li class="md-tabs__item md-tabs__item--active"> <a href=../about/ class=md-tabs__link> CLI </a> </li> <li class=md-tabs__item> <a href=../../plugins/about/ class=md-tabs__link> Plugins </a> </li> <li class=md-tabs__item> <a href=../../how-to/meta/report-issues/ class=md-tabs__link> How-to </a> </li> <li class=md-tabs__item> <a href=../../tutorials/python/manage/ class=md-tabs__link> Tutorials </a> </li> <li class=md-tabs__item> <a href=../../meta/faq/ class=md-tabs__link> Meta </a> </li> <li class=md-tabs__item> <a href=../../blog/ class=md-tabs__link> Blog </a> </li> </ul> </div> </nav> </header> <div class=md-container data-md-component=container> <main class=md-main data-md-component=main> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component=sidebar data-md-type=navigation> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--primary md-nav--lifted" aria-label=Navigation data-md-level=0> <label class=md-nav__title for=__drawer> <a href=../.. title=Hatch class="md-nav__button md-logo" aria-label=Hatch data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19.5 14.5A7.5 7.5 0 0 1 12 22a7.5 7.5 0 0 1-7.5-7.5C4.5 10.36 7.86 2 12 2c4.14 0 7.5 8.36 7.5 12.5Z"/></svg> </a> Hatch </label> <div class=md-nav__source> <a href=https://github.com/pypa/hatch title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 480 512"><!-- Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"/></svg> </div> <div class=md-source__repository> pypa/hatch </div> </a> </div> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_1> <label class=md-nav__link for=__nav_1 id=__nav_1_label tabindex=0> <span class=md-ellipsis> Home </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_1_label aria-expanded=false> <label class=md-nav__title for=__nav_1> <span class="md-nav__icon md-icon"></span> Home </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../.. class=md-nav__link> <span class=md-ellipsis> About </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_1_2> <label class=md-nav__link for=__nav_1_2 id=__nav_1_2_label tabindex=0> <span class=md-ellipsis> Walkthrough </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_1_2_label aria-expanded=false> <label class=md-nav__title for=__nav_1_2> <span class="md-nav__icon md-icon"></span> Walkthrough </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../install/ class=md-nav__link> <span class=md-ellipsis> Installation </span> </a> </li> <li class=md-nav__item> <a href=../../intro/ class=md-nav__link> <span class=md-ellipsis> Introduction </span> </a> </li> <li class=md-nav__item> <a href=../../environment/ class=md-nav__link> <span class=md-ellipsis> Environments </span> </a> </li> <li class=md-nav__item> <a href=../../version/ class=md-nav__link> <span class=md-ellipsis> Versioning </span> </a> </li> <li class=md-nav__item> <a href=../../build/ class=md-nav__link> <span class=md-ellipsis> Builds </span> </a> </li> <li class=md-nav__item> <a href=../../publish/ class=md-nav__link> <span class=md-ellipsis> Publishing </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_1_3> <label class=md-nav__link for=__nav_1_3 id=__nav_1_3_label tabindex=0> <span class=md-ellipsis> Learn </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_1_3_label aria-expanded=false> <label class=md-nav__title for=__nav_1_3> <span class="md-nav__icon md-icon"></span> Learn </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../next-steps/ class=md-nav__link> <span class=md-ellipsis> Next steps </span> </a> </li> <li class=md-nav__item> <a href=../../why/ class=md-nav__link> <span class=md-ellipsis> Why Hatch? </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_1_4> <label class=md-nav__link for=__nav_1_4 id=__nav_1_4_label tabindex=0> <span class=md-ellipsis> History </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_1_4_label aria-expanded=false> <label class=md-nav__title for=__nav_1_4> <span class="md-nav__icon md-icon"></span> History </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../history/hatch/ class=md-nav__link> <span class=md-ellipsis> Hatch </span> </a> </li> <li class=md-nav__item> <a href=../../history/hatchling/ class=md-nav__link> <span class=md-ellipsis> Hatchling </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_1_5> <label class=md-nav__link for=__nav_1_5 id=__nav_1_5_label tabindex=0> <span class=md-ellipsis> Community </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_1_5_label aria-expanded=false> <label class=md-nav__title for=__nav_1_5> <span class="md-nav__icon md-icon"></span> Community </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../community/users/ class=md-nav__link> <span class=md-ellipsis> Users </span> </a> </li> <li class=md-nav__item> <a href=../../community/highlights/ class=md-nav__link> <span class=md-ellipsis> Highlights </span> </a> </li> <li class=md-nav__item> <a href=../../community/contributing/ class=md-nav__link> <span class=md-ellipsis> Contributing </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2> <label class=md-nav__link for=__nav_2 id=__nav_2_label tabindex=0> <span class=md-ellipsis> Configuration </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_2_label aria-expanded=false> <label class=md-nav__title for=__nav_2> <span class="md-nav__icon md-icon"></span> Configuration </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../config/metadata/ class=md-nav__link> <span class=md-ellipsis> Metadata </span> </a> </li> <li class=md-nav__item> <a href=../../config/dependency/ class=md-nav__link> <span class=md-ellipsis> Dependencies </span> </a> </li> <li class=md-nav__item> <a href=../../config/build/ class=md-nav__link> <span class=md-ellipsis> Build </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2_4> <label class=md-nav__link for=__nav_2_4 id=__nav_2_4_label tabindex=0> <span class=md-ellipsis> Environments </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_2_4_label aria-expanded=false> <label class=md-nav__title for=__nav_2_4> <span class="md-nav__icon md-icon"></span> Environments </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../config/environment/overview/ class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> <li class=md-nav__item> <a href=../../config/environment/advanced/ class=md-nav__link> <span class=md-ellipsis> Advanced </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2_5> <label class=md-nav__link for=__nav_2_5 id=__nav_2_5_label tabindex=0> <span class=md-ellipsis> Internal </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_2_5_label aria-expanded=false> <label class=md-nav__title for=__nav_2_5> <span class="md-nav__icon md-icon"></span> Internal </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../config/internal/testing/ class=md-nav__link> <span class=md-ellipsis> Testing </span> </a> </li> <li class=md-nav__item> <a href=../../config/internal/static-analysis/ class=md-nav__link> <span class=md-ellipsis> Static analysis </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../config/context/ class=md-nav__link> <span class=md-ellipsis> Context formatting </span> </a> </li> <li class=md-nav__item> <a href=../../config/project-templates/ class=md-nav__link> <span class=md-ellipsis> Project templates </span> </a> </li> <li class=md-nav__item> <a href=../../config/hatch/ class=md-nav__link> <span class=md-ellipsis> Hatch </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_3 checked> <label class=md-nav__link for=__nav_3 id=__nav_3_label tabindex> <span class=md-ellipsis> CLI </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_3_label aria-expanded=true> <label class=md-nav__title for=__nav_3> <span class="md-nav__icon md-icon"></span> CLI </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../about/ class=md-nav__link> <span class=md-ellipsis> About </span> </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type=checkbox id=__toc> <label class="md-nav__link md-nav__link--active" for=__toc> <span class=md-ellipsis> Reference </span> <span class="md-nav__icon md-icon"></span> </label> <a href=./ class="md-nav__link md-nav__link--active"> <span class=md-ellipsis> Reference </span> </a> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-component=toc data-md-scrollfix> <li class=md-nav__item> <a href=#hatch-build class=md-nav__link> <span class=md-ellipsis> build </span> </a> </li> <li class=md-nav__item> <a href=#hatch-clean class=md-nav__link> <span class=md-ellipsis> clean </span> </a> </li> <li class=md-nav__item> <a href=#hatch-config class=md-nav__link> <span class=md-ellipsis> config </span> </a> <nav class=md-nav aria-label=config> <ul class=md-nav__list> <li class=md-nav__item> <a href=#hatch-config-explore class=md-nav__link> <span class=md-ellipsis> explore </span> </a> </li> <li class=md-nav__item> <a href=#hatch-config-find class=md-nav__link> <span class=md-ellipsis> find </span> </a> </li> <li class=md-nav__item> <a href=#hatch-config-restore class=md-nav__link> <span class=md-ellipsis> restore </span> </a> </li> <li class=md-nav__item> <a href=#hatch-config-set class=md-nav__link> <span class=md-ellipsis> set </span> </a> </li> <li class=md-nav__item> <a href=#hatch-config-show class=md-nav__link> <span class=md-ellipsis> show </span> </a> </li> <li class=md-nav__item> <a href=#hatch-config-update class=md-nav__link> <span class=md-ellipsis> update </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#hatch-dep class=md-nav__link> <span class=md-ellipsis> dep </span> </a> <nav class=md-nav aria-label=dep> <ul class=md-nav__list> <li class=md-nav__item> <a href=#hatch-dep-hash class=md-nav__link> <span class=md-ellipsis> hash </span> </a> </li> <li class=md-nav__item> <a href=#hatch-dep-show class=md-nav__link> <span class=md-ellipsis> show </span> </a> <nav class=md-nav aria-label=show> <ul class=md-nav__list> <li class=md-nav__item> <a href=#hatch-dep-show-requirements class=md-nav__link> <span class=md-ellipsis> requirements </span> </a> </li> <li class=md-nav__item> <a href=#hatch-dep-show-table class=md-nav__link> <span class=md-ellipsis> table </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#hatch-env class=md-nav__link> <span class=md-ellipsis> env </span> </a> <nav class=md-nav aria-label=env> <ul class=md-nav__list> <li class=md-nav__item> <a href=#hatch-env-create class=md-nav__link> <span class=md-ellipsis> create </span> </a> </li> <li class=md-nav__item> <a href=#hatch-env-find class=md-nav__link> <span class=md-ellipsis> find </span> </a> </li> <li class=md-nav__item> <a href=#hatch-env-prune class=md-nav__link> <span class=md-ellipsis> prune </span> </a> </li> <li class=md-nav__item> <a href=#hatch-env-remove class=md-nav__link> <span class=md-ellipsis> remove </span> </a> </li> <li class=md-nav__item> <a href=#hatch-env-run class=md-nav__link> <span class=md-ellipsis> run </span> </a> </li> <li class=md-nav__item> <a href=#hatch-env-show class=md-nav__link> <span class=md-ellipsis> show </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#hatch-fmt class=md-nav__link> <span class=md-ellipsis> fmt </span> </a> </li> <li class=md-nav__item> <a href=#hatch-new class=md-nav__link> <span class=md-ellipsis> new </span> </a> </li> <li class=md-nav__item> <a href=#hatch-project class=md-nav__link> <span class=md-ellipsis> project </span> </a> <nav class=md-nav aria-label=project> <ul class=md-nav__list> <li class=md-nav__item> <a href=#hatch-project-metadata class=md-nav__link> <span class=md-ellipsis> metadata </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#hatch-publish class=md-nav__link> <span class=md-ellipsis> publish </span> </a> </li> <li class=md-nav__item> <a href=#hatch-python class=md-nav__link> <span class=md-ellipsis> python </span> </a> <nav class=md-nav aria-label=python> <ul class=md-nav__list> <li class=md-nav__item> <a href=#hatch-python-find class=md-nav__link> <span class=md-ellipsis> find </span> </a> </li> <li class=md-nav__item> <a href=#hatch-python-install class=md-nav__link> <span class=md-ellipsis> install </span> </a> </li> <li class=md-nav__item> <a href=#hatch-python-remove class=md-nav__link> <span class=md-ellipsis> remove </span> </a> </li> <li class=md-nav__item> <a href=#hatch-python-show class=md-nav__link> <span class=md-ellipsis> show </span> </a> </li> <li class=md-nav__item> <a href=#hatch-python-update class=md-nav__link> <span class=md-ellipsis> update </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#hatch-run class=md-nav__link> <span class=md-ellipsis> run </span> </a> </li> <li class=md-nav__item> <a href=#hatch-self class=md-nav__link> <span class=md-ellipsis> self </span> </a> <nav class=md-nav aria-label=self> <ul class=md-nav__list> <li class=md-nav__item> <a href=#hatch-self-report class=md-nav__link> <span class=md-ellipsis> report </span> </a> </li> <li class=md-nav__item> <a href=#hatch-self-restore class=md-nav__link> <span class=md-ellipsis> restore </span> </a> </li> <li class=md-nav__item> <a href=#hatch-self-update class=md-nav__link> <span class=md-ellipsis> update </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#hatch-shell class=md-nav__link> <span class=md-ellipsis> shell </span> </a> </li> <li class=md-nav__item> <a href=#hatch-status class=md-nav__link> <span class=md-ellipsis> status </span> </a> </li> <li class=md-nav__item> <a href=#hatch-test class=md-nav__link> <span class=md-ellipsis> test </span> </a> </li> <li class=md-nav__item> <a href=#hatch-version class=md-nav__link> <span class=md-ellipsis> version </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4> <label class=md-nav__link for=__nav_4 id=__nav_4_label tabindex=0> <span class=md-ellipsis> Plugins </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_4_label aria-expanded=false> <label class=md-nav__title for=__nav_4> <span class="md-nav__icon md-icon"></span> Plugins </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/about/ class=md-nav__link> <span class=md-ellipsis> About </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_2> <label class=md-nav__link for=__nav_4_2 id=__nav_4_2_label tabindex=0> <span class=md-ellipsis> Builder </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_2_label aria-expanded=false> <label class=md-nav__title for=__nav_4_2> <span class="md-nav__icon md-icon"></span> Builder </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/builder/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/builder/wheel/ class=md-nav__link> <span class=md-ellipsis> Wheel </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/builder/sdist/ class=md-nav__link> <span class=md-ellipsis> Source distribution </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/builder/binary/ class=md-nav__link> <span class=md-ellipsis> Binary </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/builder/custom/ class=md-nav__link> <span class=md-ellipsis> Custom </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_3> <label class=md-nav__link for=__nav_4_3 id=__nav_4_3_label tabindex=0> <span class=md-ellipsis> Build hook </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_3_label aria-expanded=false> <label class=md-nav__title for=__nav_4_3> <span class="md-nav__icon md-icon"></span> Build hook </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/build-hook/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/build-hook/version/ class=md-nav__link> <span class=md-ellipsis> Version </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/build-hook/custom/ class=md-nav__link> <span class=md-ellipsis> Custom </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_4> <label class=md-nav__link for=__nav_4_4 id=__nav_4_4_label tabindex=0> <span class=md-ellipsis> Metadata hook </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_4_label aria-expanded=false> <label class=md-nav__title for=__nav_4_4> <span class="md-nav__icon md-icon"></span> Metadata hook </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/metadata-hook/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/metadata-hook/custom/ class=md-nav__link> <span class=md-ellipsis> Custom </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_5> <label class=md-nav__link for=__nav_4_5 id=__nav_4_5_label tabindex=0> <span class=md-ellipsis> Environment </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_5_label aria-expanded=false> <label class=md-nav__title for=__nav_4_5> <span class="md-nav__icon md-icon"></span> Environment </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/environment/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/environment/virtual/ class=md-nav__link> <span class=md-ellipsis> Virtual </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_6> <label class=md-nav__link for=__nav_4_6 id=__nav_4_6_label tabindex=0> <span class=md-ellipsis> Environment collector </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_6_label aria-expanded=false> <label class=md-nav__title for=__nav_4_6> <span class="md-nav__icon md-icon"></span> Environment collector </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/environment-collector/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/environment-collector/custom/ class=md-nav__link> <span class=md-ellipsis> Custom </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/environment-collector/default/ class=md-nav__link> <span class=md-ellipsis> Default </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_7> <label class=md-nav__link for=__nav_4_7 id=__nav_4_7_label tabindex=0> <span class=md-ellipsis> Publisher </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_7_label aria-expanded=false> <label class=md-nav__title for=__nav_4_7> <span class="md-nav__icon md-icon"></span> Publisher </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/publisher/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/publisher/package-index/ class=md-nav__link> <span class=md-ellipsis> Index </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_8> <label class=md-nav__link for=__nav_4_8 id=__nav_4_8_label tabindex=0> <span class=md-ellipsis> Version source </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_8_label aria-expanded=false> <label class=md-nav__title for=__nav_4_8> <span class="md-nav__icon md-icon"></span> Version source </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/version-source/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/version-source/regex/ class=md-nav__link> <span class=md-ellipsis> Regex </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/version-source/code/ class=md-nav__link> <span class=md-ellipsis> Code </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/version-source/env/ class=md-nav__link> <span class=md-ellipsis> Environment </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_9> <label class=md-nav__link for=__nav_4_9 id=__nav_4_9_label tabindex=0> <span class=md-ellipsis> Version scheme </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_9_label aria-expanded=false> <label class=md-nav__title for=__nav_4_9> <span class="md-nav__icon md-icon"></span> Version scheme </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/version-scheme/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/version-scheme/standard/ class=md-nav__link> <span class=md-ellipsis> Standard </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../plugins/utilities/ class=md-nav__link> <span class=md-ellipsis> Utilities </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5> <label class=md-nav__link for=__nav_5 id=__nav_5_label tabindex=0> <span class=md-ellipsis> How-to </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_5_label aria-expanded=false> <label class=md-nav__title for=__nav_5> <span class="md-nav__icon md-icon"></span> How-to </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_1> <label class=md-nav__link for=__nav_5_1 id=__nav_5_1_label tabindex=0> <span class=md-ellipsis> Meta </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_1_label aria-expanded=false> <label class=md-nav__title for=__nav_5_1> <span class="md-nav__icon md-icon"></span> Meta </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/meta/report-issues/ class=md-nav__link> <span class=md-ellipsis> Report issues </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_2> <label class=md-nav__link for=__nav_5_2 id=__nav_5_2_label tabindex=0> <span class=md-ellipsis> Integrate </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_2_label aria-expanded=false> <label class=md-nav__title for=__nav_5_2> <span class="md-nav__icon md-icon"></span> Integrate </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/integrate/vscode/ class=md-nav__link> <span class=md-ellipsis> Visual Studio Code </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_3> <label class=md-nav__link for=__nav_5_3 id=__nav_5_3_label tabindex=0> <span class=md-ellipsis> Run </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_3_label aria-expanded=false> <label class=md-nav__title for=__nav_5_3> <span class="md-nav__icon md-icon"></span> Run </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/run/python-scripts/ class=md-nav__link> <span class=md-ellipsis> Python scripts </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_4> <label class=md-nav__link for=__nav_5_4 id=__nav_5_4_label tabindex=0> <span class=md-ellipsis> Config </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_4_label aria-expanded=false> <label class=md-nav__title for=__nav_5_4> <span class="md-nav__icon md-icon"></span> Config </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/config/dynamic-metadata/ class=md-nav__link> <span class=md-ellipsis> Dynamic metadata </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_5> <label class=md-nav__link for=__nav_5_5 id=__nav_5_5_label tabindex=0> <span class=md-ellipsis> Environments </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_5_label aria-expanded=false> <label class=md-nav__title for=__nav_5_5> <span class="md-nav__icon md-icon"></span> Environments </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/environment/select-installer/ class=md-nav__link> <span class=md-ellipsis> Select installer </span> </a> </li> <li class=md-nav__item> <a href=../../how-to/environment/dependency-resolution/ class=md-nav__link> <span class=md-ellipsis> Dependency resolution </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_6> <label class=md-nav__link for=__nav_5_6 id=__nav_5_6_label tabindex=0> <span class=md-ellipsis> Static analysis </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_6_label aria-expanded=false> <label class=md-nav__title for=__nav_5_6> <span class="md-nav__icon md-icon"></span> Static analysis </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/static-analysis/behavior/ class=md-nav__link> <span class=md-ellipsis> Customize behavior </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_7> <label class=md-nav__link for=__nav_5_7 id=__nav_5_7_label tabindex=0> <span class=md-ellipsis> Python </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_7_label aria-expanded=false> <label class=md-nav__title for=__nav_5_7> <span class="md-nav__icon md-icon"></span> Python </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/python/custom/ class=md-nav__link> <span class=md-ellipsis> Custom distributions </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_8> <label class=md-nav__link for=__nav_5_8 id=__nav_5_8_label tabindex=0> <span class=md-ellipsis> Publishing </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_8_label aria-expanded=false> <label class=md-nav__title for=__nav_5_8> <span class="md-nav__icon md-icon"></span> Publishing </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/publish/auth/ class=md-nav__link> <span class=md-ellipsis> Authentication </span> </a> </li> <li class=md-nav__item> <a href=../../how-to/publish/repo/ class=md-nav__link> <span class=md-ellipsis> Repository selection </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_9> <label class=md-nav__link for=__nav_5_9 id=__nav_5_9_label tabindex=0> <span class=md-ellipsis> Plugins </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_9_label aria-expanded=false> <label class=md-nav__title for=__nav_5_9> <span class="md-nav__icon md-icon"></span> Plugins </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/plugins/testing-builds/ class=md-nav__link> <span class=md-ellipsis> Testing builds </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_6> <label class=md-nav__link for=__nav_6 id=__nav_6_label tabindex=0> <span class=md-ellipsis> Tutorials </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_6_label aria-expanded=false> <label class=md-nav__title for=__nav_6> <span class="md-nav__icon md-icon"></span> Tutorials </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_6_1> <label class=md-nav__link for=__nav_6_1 id=__nav_6_1_label tabindex=0> <span class=md-ellipsis> Python </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_6_1_label aria-expanded=false> <label class=md-nav__title for=__nav_6_1> <span class="md-nav__icon md-icon"></span> Python </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../tutorials/python/manage/ class=md-nav__link> <span class=md-ellipsis> Management </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_6_2> <label class=md-nav__link for=__nav_6_2 id=__nav_6_2_label tabindex=0> <span class=md-ellipsis> Environments </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_6_2_label aria-expanded=false> <label class=md-nav__title for=__nav_6_2> <span class="md-nav__icon md-icon"></span> Environments </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../tutorials/environment/basic-usage/ class=md-nav__link> <span class=md-ellipsis> Basic usage </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_6_3> <label class=md-nav__link for=__nav_6_3 id=__nav_6_3_label tabindex=0> <span class=md-ellipsis> Testing </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_6_3_label aria-expanded=false> <label class=md-nav__title for=__nav_6_3> <span class="md-nav__icon md-icon"></span> Testing </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../tutorials/testing/overview/ class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_7> <label class=md-nav__link for=__nav_7 id=__nav_7_label tabindex=0> <span class=md-ellipsis> Meta </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_7_label aria-expanded=false> <label class=md-nav__title for=__nav_7> <span class="md-nav__icon md-icon"></span> Meta </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../meta/faq/ class=md-nav__link> <span class=md-ellipsis> FAQ </span> </a> </li> <li class=md-nav__item> <a href=../../meta/authors/ class=md-nav__link> <span class=md-ellipsis> Authors </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_8> <label class=md-nav__link for=__nav_8 id=__nav_8_label tabindex=0> <span class=md-ellipsis> Blog </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_8_label aria-expanded=false> <label class=md-nav__title for=__nav_8> <span class="md-nav__icon md-icon"></span> Blog </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../blog/ class=md-nav__link> <span class=md-ellipsis> Blog </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_8_2> <label class=md-nav__link for=__nav_8_2 id=__nav_8_2_label tabindex=0> <span class=md-ellipsis> Archive </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_8_2_label aria-expanded=false> <label class=md-nav__title for=__nav_8_2> <span class="md-nav__icon md-icon"></span> Archive </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../blog/archive/2024/ class=md-nav__link> <span class=md-ellipsis> 2024 </span> </a> </li> <li class=md-nav__item> <a href=../../blog/archive/2023/ class=md-nav__link> <span class=md-ellipsis> 2023 </span> </a> </li> <li class=md-nav__item> <a href=../../blog/archive/2022/ class=md-nav__link> <span class=md-ellipsis> 2022 </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_8_3> <label class=md-nav__link for=__nav_8_3 id=__nav_8_3_label tabindex=0> <span class=md-ellipsis> Categories </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_8_3_label aria-expanded=false> <label class=md-nav__title for=__nav_8_3> <span class="md-nav__icon md-icon"></span> Categories </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../blog/category/release/ class=md-nav__link> <span class=md-ellipsis> Release </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component=sidebar data-md-type=toc> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-component=toc data-md-scrollfix> <li class=md-nav__item> <a href=#hatch-build class=md-nav__link> <span class=md-ellipsis> build </span> </a> </li> <li class=md-nav__item> <a href=#hatch-clean class=md-nav__link> <span class=md-ellipsis> clean </span> </a> </li> <li class=md-nav__item> <a href=#hatch-config class=md-nav__link> <span class=md-ellipsis> config </span> </a> <nav class=md-nav aria-label=config> <ul class=md-nav__list> <li class=md-nav__item> <a href=#hatch-config-explore class=md-nav__link> <span class=md-ellipsis> explore </span> </a> </li> <li class=md-nav__item> <a href=#hatch-config-find class=md-nav__link> <span class=md-ellipsis> find </span> </a> </li> <li class=md-nav__item> <a href=#hatch-config-restore class=md-nav__link> <span class=md-ellipsis> restore </span> </a> </li> <li class=md-nav__item> <a href=#hatch-config-set class=md-nav__link> <span class=md-ellipsis> set </span> </a> </li> <li class=md-nav__item> <a href=#hatch-config-show class=md-nav__link> <span class=md-ellipsis> show </span> </a> </li> <li class=md-nav__item> <a href=#hatch-config-update class=md-nav__link> <span class=md-ellipsis> update </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#hatch-dep class=md-nav__link> <span class=md-ellipsis> dep </span> </a> <nav class=md-nav aria-label=dep> <ul class=md-nav__list> <li class=md-nav__item> <a href=#hatch-dep-hash class=md-nav__link> <span class=md-ellipsis> hash </span> </a> </li> <li class=md-nav__item> <a href=#hatch-dep-show class=md-nav__link> <span class=md-ellipsis> show </span> </a> <nav class=md-nav aria-label=show> <ul class=md-nav__list> <li class=md-nav__item> <a href=#hatch-dep-show-requirements class=md-nav__link> <span class=md-ellipsis> requirements </span> </a> </li> <li class=md-nav__item> <a href=#hatch-dep-show-table class=md-nav__link> <span class=md-ellipsis> table </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#hatch-env class=md-nav__link> <span class=md-ellipsis> env </span> </a> <nav class=md-nav aria-label=env> <ul class=md-nav__list> <li class=md-nav__item> <a href=#hatch-env-create class=md-nav__link> <span class=md-ellipsis> create </span> </a> </li> <li class=md-nav__item> <a href=#hatch-env-find class=md-nav__link> <span class=md-ellipsis> find </span> </a> </li> <li class=md-nav__item> <a href=#hatch-env-prune class=md-nav__link> <span class=md-ellipsis> prune </span> </a> </li> <li class=md-nav__item> <a href=#hatch-env-remove class=md-nav__link> <span class=md-ellipsis> remove </span> </a> </li> <li class=md-nav__item> <a href=#hatch-env-run class=md-nav__link> <span class=md-ellipsis> run </span> </a> </li> <li class=md-nav__item> <a href=#hatch-env-show class=md-nav__link> <span class=md-ellipsis> show </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#hatch-fmt class=md-nav__link> <span class=md-ellipsis> fmt </span> </a> </li> <li class=md-nav__item> <a href=#hatch-new class=md-nav__link> <span class=md-ellipsis> new </span> </a> </li> <li class=md-nav__item> <a href=#hatch-project class=md-nav__link> <span class=md-ellipsis> project </span> </a> <nav class=md-nav aria-label=project> <ul class=md-nav__list> <li class=md-nav__item> <a href=#hatch-project-metadata class=md-nav__link> <span class=md-ellipsis> metadata </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#hatch-publish class=md-nav__link> <span class=md-ellipsis> publish </span> </a> </li> <li class=md-nav__item> <a href=#hatch-python class=md-nav__link> <span class=md-ellipsis> python </span> </a> <nav class=md-nav aria-label=python> <ul class=md-nav__list> <li class=md-nav__item> <a href=#hatch-python-find class=md-nav__link> <span class=md-ellipsis> find </span> </a> </li> <li class=md-nav__item> <a href=#hatch-python-install class=md-nav__link> <span class=md-ellipsis> install </span> </a> </li> <li class=md-nav__item> <a href=#hatch-python-remove class=md-nav__link> <span class=md-ellipsis> remove </span> </a> </li> <li class=md-nav__item> <a href=#hatch-python-show class=md-nav__link> <span class=md-ellipsis> show </span> </a> </li> <li class=md-nav__item> <a href=#hatch-python-update class=md-nav__link> <span class=md-ellipsis> update </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#hatch-run class=md-nav__link> <span class=md-ellipsis> run </span> </a> </li> <li class=md-nav__item> <a href=#hatch-self class=md-nav__link> <span class=md-ellipsis> self </span> </a> <nav class=md-nav aria-label=self> <ul class=md-nav__list> <li class=md-nav__item> <a href=#hatch-self-report class=md-nav__link> <span class=md-ellipsis> report </span> </a> </li> <li class=md-nav__item> <a href=#hatch-self-restore class=md-nav__link> <span class=md-ellipsis> restore </span> </a> </li> <li class=md-nav__item> <a href=#hatch-self-update class=md-nav__link> <span class=md-ellipsis> update </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#hatch-shell class=md-nav__link> <span class=md-ellipsis> shell </span> </a> </li> <li class=md-nav__item> <a href=#hatch-status class=md-nav__link> <span class=md-ellipsis> status </span> </a> </li> <li class=md-nav__item> <a href=#hatch-test class=md-nav__link> <span class=md-ellipsis> test </span> </a> </li> <li class=md-nav__item> <a href=#hatch-version class=md-nav__link> <span class=md-ellipsis> version </span> </a> </li> </ul> </nav> </div> </div> </div> <div class=md-content data-md-component=content> <article class="md-content__inner md-typeset"> <a href=https://github.com/pypa/hatch/blob/master/docs/cli/reference.md title="Edit this page" class="md-content__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4v-2m10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1 2.1 2.1Z"/></svg> </a> <h1 id=hatch>hatch<a class=headerlink href=#hatch title="Permanent link">¶</a></h1> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch [OPTIONS] COMMAND [ARGS]...
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--env</code>, <code>-e</code></td> <td>text</td> <td>The name of the environment to use [env var: <code>HATCH_ENV</code>]</td> <td><code>default</code></td> </tr> <tr> <td><code>--project</code>, <code>-p</code></td> <td>text</td> <td>The name of the project to work on [env var: <code>HATCH_PROJECT</code>]</td> <td>None</td> </tr> <tr> <td><code>--verbose</code>, <code>-v</code></td> <td>integer range (<code>0</code> and above)</td> <td>Increase verbosity (can be used additively) [env var: <code>HATCH_VERBOSE</code>]</td> <td><code>0</code></td> </tr> <tr> <td><code>--quiet</code>, <code>-q</code></td> <td>integer range (<code>0</code> and above)</td> <td>Decrease verbosity (can be used additively) [env var: <code>HATCH_QUIET</code>]</td> <td><code>0</code></td> </tr> <tr> <td><code>--color</code> / <code>--no-color</code></td> <td>boolean</td> <td>Whether or not to display colored output (default is auto-detection) [env vars: <code>FORCE_COLOR</code>/<code>NO_COLOR</code>]</td> <td>None</td> </tr> <tr> <td><code>--interactive</code> / <code>--no-interactive</code></td> <td>boolean</td> <td>Whether or not to allow features like prompts and progress bars (default is auto-detection) [env var: <code>HATCH_INTERACTIVE</code>]</td> <td>None</td> </tr> <tr> <td><code>--data-dir</code></td> <td>text</td> <td>The path to a custom directory used to persist data [env var: <code>HATCH_DATA_DIR</code>]</td> <td>None</td> </tr> <tr> <td><code>--cache-dir</code></td> <td>text</td> <td>The path to a custom directory used to cache data [env var: <code>HATCH_CACHE_DIR</code>]</td> <td>None</td> </tr> <tr> <td><code>--config</code></td> <td>text</td> <td>The path to a custom config file to use [env var: <code>HATCH_CONFIG</code>]</td> <td>None</td> </tr> <tr> <td><code>--version</code></td> <td>boolean</td> <td>Show the version and exit.</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=hatch-build>hatch build<a class=headerlink href=#hatch-build title="Permanent link">¶</a></h2> <p>Build a project.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch build [OPTIONS] [LOCATION]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--target</code>, <code>-t</code></td> <td>text</td> <td>The target to build, overriding project defaults. This may be selected multiple times e.g. <code>-t sdist -t wheel</code></td> <td>None</td> </tr> <tr> <td><code>--hooks-only</code></td> <td>boolean</td> <td>Whether or not to only execute build hooks [env var: <code>HATCH_BUILD_HOOKS_ONLY</code>]</td> <td><code>False</code></td> </tr> <tr> <td><code>--no-hooks</code></td> <td>boolean</td> <td>Whether or not to disable build hooks [env var: <code>HATCH_BUILD_NO_HOOKS</code>]</td> <td><code>False</code></td> </tr> <tr> <td><code>--ext</code></td> <td>boolean</td> <td>Whether or not to only execute build hooks for distributing binary Python packages, such as compiling extensions. Equivalent to <code>--hooks-only -t wheel</code></td> <td><code>False</code></td> </tr> <tr> <td><code>--clean</code>, <code>-c</code></td> <td>boolean</td> <td>Whether or not existing artifacts should first be removed [env var: <code>HATCH_BUILD_CLEAN</code>]</td> <td><code>False</code></td> </tr> <tr> <td><code>--clean-hooks-after</code></td> <td>boolean</td> <td>Whether or not build hook artifacts should be removed after each build [env var: <code>HATCH_BUILD_CLEAN_HOOKS_AFTER</code>]</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=hatch-clean>hatch clean<a class=headerlink href=#hatch-clean title="Permanent link">¶</a></h2> <p>Remove build artifacts.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch clean [OPTIONS] [LOCATION]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--target</code>, <code>-t</code></td> <td>text</td> <td>The target with which to remove artifacts, overriding project defaults. This may be selected multiple times e.g. <code>-t sdist -t wheel</code></td> <td>None</td> </tr> <tr> <td><code>--hooks-only</code></td> <td>boolean</td> <td>Whether or not to only remove artifacts from build hooks [env var: <code>HATCH_BUILD_HOOKS_ONLY</code>]</td> <td><code>False</code></td> </tr> <tr> <td><code>--no-hooks</code></td> <td>boolean</td> <td>Whether or not to ignore artifacts from build hooks [env var: <code>HATCH_BUILD_NO_HOOKS</code>]</td> <td><code>False</code></td> </tr> <tr> <td><code>--ext</code></td> <td>boolean</td> <td>Whether or not to only remove artifacts from build hooks for distributing binary Python packages, such as compiled extensions. Equivalent to <code>--hooks-only -t wheel</code></td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=hatch-config>hatch config<a class=headerlink href=#hatch-config title="Permanent link">¶</a></h2> <p>Manage the config file</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch config [OPTIONS] COMMAND [ARGS]...
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-config-explore>hatch config explore<a class=headerlink href=#hatch-config-explore title="Permanent link">¶</a></h3> <p>Open the config location in your file manager.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch config explore [OPTIONS]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-config-find>hatch config find<a class=headerlink href=#hatch-config-find title="Permanent link">¶</a></h3> <p>Show the location of the config file.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch config find [OPTIONS]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-config-restore>hatch config restore<a class=headerlink href=#hatch-config-restore title="Permanent link">¶</a></h3> <p>Restore the config file to default settings.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch config restore [OPTIONS]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-config-set>hatch config set<a class=headerlink href=#hatch-config-set title="Permanent link">¶</a></h3> <p>Assign values to config file entries. If the value is omitted, you will be prompted, with the input hidden if it is sensitive.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch config set [OPTIONS] KEY [VALUE]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-config-show>hatch config show<a class=headerlink href=#hatch-config-show title="Permanent link">¶</a></h3> <p>Show the contents of the config file.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch config show [OPTIONS]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--all</code>, <code>-a</code></td> <td>boolean</td> <td>Do not scrub secret fields</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-config-update>hatch config update<a class=headerlink href=#hatch-config-update title="Permanent link">¶</a></h3> <p>Update the config file with any new fields.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch config update [OPTIONS]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=hatch-dep>hatch dep<a class=headerlink href=#hatch-dep title="Permanent link">¶</a></h2> <p>Manage environment dependencies</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch dep [OPTIONS] COMMAND [ARGS]...
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-dep-hash>hatch dep hash<a class=headerlink href=#hatch-dep-hash title="Permanent link">¶</a></h3> <p>Output a hash of the currently defined dependencies.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch dep hash [OPTIONS]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--project-only</code>, <code>-p</code></td> <td>boolean</td> <td>Whether or not to exclude environment dependencies</td> <td><code>False</code></td> </tr> <tr> <td><code>--env-only</code>, <code>-e</code></td> <td>boolean</td> <td>Whether or not to exclude project dependencies</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-dep-show>hatch dep show<a class=headerlink href=#hatch-dep-show title="Permanent link">¶</a></h3> <p>Display dependencies in various formats</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch dep show [OPTIONS] COMMAND [ARGS]...
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h4 id=hatch-dep-show-requirements>hatch dep show requirements<a class=headerlink href=#hatch-dep-show-requirements title="Permanent link">¶</a></h4> <p>Enumerate dependencies as a list of requirements.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch dep show requirements [OPTIONS]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--project-only</code>, <code>-p</code></td> <td>boolean</td> <td>Whether or not to exclude environment dependencies</td> <td><code>False</code></td> </tr> <tr> <td><code>--env-only</code>, <code>-e</code></td> <td>boolean</td> <td>Whether or not to exclude project dependencies</td> <td><code>False</code></td> </tr> <tr> <td><code>--feature</code>, <code>-f</code></td> <td>text</td> <td>Whether or not to only show the dependencies of the specified features</td> <td>None</td> </tr> <tr> <td><code>--all</code></td> <td>boolean</td> <td>Whether or not to include the dependencies of all features</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h4 id=hatch-dep-show-table>hatch dep show table<a class=headerlink href=#hatch-dep-show-table title="Permanent link">¶</a></h4> <p>Enumerate dependencies in a tabular format.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch dep show table [OPTIONS]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--project-only</code>, <code>-p</code></td> <td>boolean</td> <td>Whether or not to exclude environment dependencies</td> <td><code>False</code></td> </tr> <tr> <td><code>--env-only</code>, <code>-e</code></td> <td>boolean</td> <td>Whether or not to exclude project dependencies</td> <td><code>False</code></td> </tr> <tr> <td><code>--lines</code>, <code>-l</code></td> <td>boolean</td> <td>Whether or not to show lines between table rows</td> <td><code>False</code></td> </tr> <tr> <td><code>--ascii</code></td> <td>boolean</td> <td>Whether or not to only use ASCII characters</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=hatch-env>hatch env<a class=headerlink href=#hatch-env title="Permanent link">¶</a></h2> <p>Manage project environments</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch env [OPTIONS] COMMAND [ARGS]...
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-env-create>hatch env create<a class=headerlink href=#hatch-env-create title="Permanent link">¶</a></h3> <p>Create environments.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch env create [OPTIONS] [ENV_NAME]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-env-find>hatch env find<a class=headerlink href=#hatch-env-find title="Permanent link">¶</a></h3> <p>Locate environments.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch env find [OPTIONS] [ENV_NAME]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-env-prune>hatch env prune<a class=headerlink href=#hatch-env-prune title="Permanent link">¶</a></h3> <p>Remove all environments.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch env prune [OPTIONS]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-env-remove>hatch env remove<a class=headerlink href=#hatch-env-remove title="Permanent link">¶</a></h3> <p>Remove environments.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch env remove [OPTIONS] [ENV_NAME]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-env-run>hatch env run<a class=headerlink href=#hatch-env-run title="Permanent link">¶</a></h3> <p>Run commands within project environments.</p> <p>The <code>-e</code>/<code>--env</code> option overrides the equivalent <a href=#hatch>root option</a> and the <code>HATCH_ENV</code> environment variable.</p> <p>The <code>-i</code>/<code>--include</code> and <code>-x</code>/<code>--exclude</code> options may be used to include or exclude certain variables, optionally followed by specific comma-separated values, and may be selected multiple times. For example, if you have the following configuration:</p> <div class="tabbed-set tabbed-alternate" data-tabs=1:2><input checked=checked id=pyprojecttoml name=__tabbed_1 type=radio><input id=hatchtoml name=__tabbed_1 type=radio><div class=tabbed-labels><label for=pyprojecttoml><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> pyproject.toml</label><label for=hatchtoml><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> hatch.toml</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[[tool.hatch.envs.test.matrix]]</span>
|
|
<span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"3.9"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.10"</span><span class=p>]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.14"</span><span class=p>,</span><span class=w> </span><span class=s2>"9000"</span><span class=p>]</span>
|
|
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[[envs.test.matrix]]</span>
|
|
<span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"3.9"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.10"</span><span class=p>]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.14"</span><span class=p>,</span><span class=w> </span><span class=s2>"9000"</span><span class=p>]</span>
|
|
</code></pre></div> </div> </div> </div> <p>then running:</p> <div class=highlight><pre><span></span><code>hatch env run -i py=3.10 -x version=9000 test:pytest
|
|
</code></pre></div> <p>would execute <code>pytest</code> in the environments <code>test.py3.10-42</code> and <code>test.py3.10-3.14</code>. Note that <code>py</code> may be used as an alias for <code>python</code>.</p> <div class="admonition note"> <p class=admonition-title>Note</p> <p>The inclusion option is treated as an intersection while the exclusion option is treated as a union i.e. an environment must match all of the included variables to be selected while matching any of the excluded variables will prevent selection.</p> </div> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch env run [OPTIONS] ARGS...
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--env</code>, <code>-e</code></td> <td>text</td> <td>The environments to target</td> <td>None</td> </tr> <tr> <td><code>--include</code>, <code>-i</code></td> <td>text</td> <td>The matrix variables to include</td> <td>None</td> </tr> <tr> <td><code>--exclude</code>, <code>-x</code></td> <td>text</td> <td>The matrix variables to exclude</td> <td>None</td> </tr> <tr> <td><code>--filter</code>, <code>-f</code></td> <td>text</td> <td>The JSON data used to select environments</td> <td>None</td> </tr> <tr> <td><code>--force-continue</code></td> <td>boolean</td> <td>Run every command and if there were any errors exit with the first code</td> <td><code>False</code></td> </tr> <tr> <td><code>--ignore-compat</code></td> <td>boolean</td> <td>Ignore incompatibility when selecting specific environments</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-env-show>hatch env show<a class=headerlink href=#hatch-env-show title="Permanent link">¶</a></h3> <p>Show the available environments.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch env show [OPTIONS] [ENVS]...
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--ascii</code></td> <td>boolean</td> <td>Whether or not to only use ASCII characters</td> <td><code>False</code></td> </tr> <tr> <td><code>--json</code></td> <td>boolean</td> <td>Whether or not to output in JSON format</td> <td><code>False</code></td> </tr> <tr> <td><code>--internal</code>, <code>-i</code></td> <td>boolean</td> <td>Show internal environments</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=hatch-fmt>hatch fmt<a class=headerlink href=#hatch-fmt title="Permanent link">¶</a></h2> <p>Format and lint source code.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch fmt [OPTIONS] [ARGS]...
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--check</code></td> <td>boolean</td> <td>Only check for errors rather than fixing them</td> <td><code>False</code></td> </tr> <tr> <td><code>--linter</code>, <code>-l</code></td> <td>boolean</td> <td>Only run the linter</td> <td><code>False</code></td> </tr> <tr> <td><code>--formatter</code>, <code>-f</code></td> <td>boolean</td> <td>Only run the formatter</td> <td><code>False</code></td> </tr> <tr> <td><code>--sync</code></td> <td>boolean</td> <td>Sync the default config file with the current version of Hatch</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=hatch-new>hatch new<a class=headerlink href=#hatch-new title="Permanent link">¶</a></h2> <p>Create or initialize a project.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch new [OPTIONS] [NAME] [LOCATION]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--interactive</code>, <code>-i</code></td> <td>boolean</td> <td>Interactively choose details about the project</td> <td><code>False</code></td> </tr> <tr> <td><code>--cli</code></td> <td>boolean</td> <td>Give the project a command line interface</td> <td><code>False</code></td> </tr> <tr> <td><code>--init</code></td> <td>boolean</td> <td>Initialize an existing project</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=hatch-project>hatch project<a class=headerlink href=#hatch-project title="Permanent link">¶</a></h2> <p>View project information</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch project [OPTIONS] COMMAND [ARGS]...
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-project-metadata>hatch project metadata<a class=headerlink href=#hatch-project-metadata title="Permanent link">¶</a></h3> <p>Display project metadata.</p> <p>If you want to view the raw readme file without rendering, you can use a JSON parser like <a href=https://github.com/stedolan/jq>jq</a>:</p> <div class=highlight><pre><span></span><code>hatch project metadata | jq -r .readme
|
|
</code></pre></div> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch project metadata [OPTIONS] [FIELD]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=hatch-publish>hatch publish<a class=headerlink href=#hatch-publish title="Permanent link">¶</a></h2> <p>Publish build artifacts.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch publish [OPTIONS] [ARTIFACTS]...
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--repo</code>, <code>-r</code></td> <td>text</td> <td>The repository with which to publish artifacts [env var: <code>HATCH_INDEX_REPO</code>]</td> <td>None</td> </tr> <tr> <td><code>--user</code>, <code>-u</code></td> <td>text</td> <td>The user with which to authenticate [env var: <code>HATCH_INDEX_USER</code>]</td> <td>None</td> </tr> <tr> <td><code>--auth</code>, <code>-a</code></td> <td>text</td> <td>The credentials to use for authentication [env var: <code>HATCH_INDEX_AUTH</code>]</td> <td>None</td> </tr> <tr> <td><code>--ca-cert</code></td> <td>text</td> <td>The path to a CA bundle [env var: <code>HATCH_INDEX_CA_CERT</code>]</td> <td>None</td> </tr> <tr> <td><code>--client-cert</code></td> <td>text</td> <td>The path to a client certificate, optionally containing the private key [env var: <code>HATCH_INDEX_CLIENT_CERT</code>]</td> <td>None</td> </tr> <tr> <td><code>--client-key</code></td> <td>text</td> <td>The path to the client certificate's private key [env var: <code>HATCH_INDEX_CLIENT_KEY</code>]</td> <td>None</td> </tr> <tr> <td><code>--no-prompt</code>, <code>-n</code></td> <td>boolean</td> <td>Disable prompts, such as for missing required fields</td> <td><code>False</code></td> </tr> <tr> <td><code>--initialize-auth</code></td> <td>boolean</td> <td>Save first-time authentication information even if nothing was published</td> <td><code>False</code></td> </tr> <tr> <td><code>--publisher</code>, <code>-p</code></td> <td>text</td> <td>The publisher plugin to use (default is <code>index</code>) [env var: <code>HATCH_PUBLISHER</code>]</td> <td><code>index</code></td> </tr> <tr> <td><code>--option</code>, <code>-o</code></td> <td>text</td> <td>Options to pass to the publisher plugin. This may be selected multiple times e.g. <code>-o foo=bar -o baz=23</code> [env var: <code>HATCH_PUBLISHER_OPTIONS</code>]</td> <td>None</td> </tr> <tr> <td><code>--yes</code>, <code>-y</code></td> <td>boolean</td> <td>Confirm without prompting when the plugin is disabled</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=hatch-python>hatch python<a class=headerlink href=#hatch-python title="Permanent link">¶</a></h2> <p>Manage Python installations</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch python [OPTIONS] COMMAND [ARGS]...
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-python-find>hatch python find<a class=headerlink href=#hatch-python-find title="Permanent link">¶</a></h3> <p>Locate Python binaries.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch python find [OPTIONS] NAME
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>-p</code>, <code>--parent</code></td> <td>boolean</td> <td>Show the parent directory of the Python binary</td> <td><code>False</code></td> </tr> <tr> <td><code>--dir</code>, <code>-d</code></td> <td>text</td> <td>The directory in which distributions reside</td> <td>None</td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-python-install>hatch python install<a class=headerlink href=#hatch-python-install title="Permanent link">¶</a></h3> <p>Install Python distributions.</p> <p>You may select <code>all</code> to install all compatible distributions:</p> <div class=highlight><pre><span></span><code>hatch python install all
|
|
</code></pre></div> <p>You can set custom sources for distributions by setting the <code>HATCH_PYTHON_SOURCE_<NAME></code> environment variable where <code><NAME></code> is the uppercased version of the distribution name with periods replaced by underscores e.g. <code>HATCH_PYTHON_SOURCE_PYPY3_10</code>.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch python install [OPTIONS] NAMES...
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--private</code></td> <td>boolean</td> <td>Do not add distributions to the user PATH</td> <td><code>False</code></td> </tr> <tr> <td><code>--update</code>, <code>-u</code></td> <td>boolean</td> <td>Update existing installations</td> <td><code>False</code></td> </tr> <tr> <td><code>--dir</code>, <code>-d</code></td> <td>text</td> <td>The directory in which to install distributions, overriding configuration</td> <td>None</td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-python-remove>hatch python remove<a class=headerlink href=#hatch-python-remove title="Permanent link">¶</a></h3> <p>Remove Python distributions.</p> <p>You may select <code>all</code> to remove all installed distributions:</p> <div class=highlight><pre><span></span><code>hatch python remove all
|
|
</code></pre></div> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch python remove [OPTIONS] NAMES...
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--dir</code>, <code>-d</code></td> <td>text</td> <td>The directory in which distributions reside</td> <td>None</td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-python-show>hatch python show<a class=headerlink href=#hatch-python-show title="Permanent link">¶</a></h3> <p>Show the available Python distributions.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch python show [OPTIONS]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--ascii</code></td> <td>boolean</td> <td>Whether or not to only use ASCII characters</td> <td><code>False</code></td> </tr> <tr> <td><code>--dir</code>, <code>-d</code></td> <td>text</td> <td>The directory in which distributions reside</td> <td>None</td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-python-update>hatch python update<a class=headerlink href=#hatch-python-update title="Permanent link">¶</a></h3> <p>Update Python distributions.</p> <p>You may select <code>all</code> to update all installed distributions:</p> <div class=highlight><pre><span></span><code>hatch python update all
|
|
</code></pre></div> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch python update [OPTIONS] NAMES...
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--dir</code>, <code>-d</code></td> <td>text</td> <td>The directory in which distributions reside</td> <td>None</td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=hatch-run>hatch run<a class=headerlink href=#hatch-run title="Permanent link">¶</a></h2> <p>Run commands within project environments. This is a convenience wrapper around the <a href=#hatch-env-run><code>env run</code></a> command.</p> <p>If the first argument contains a colon, then the preceding component will be interpreted as the name of the environment to target, overriding the <code>-e</code>/<code>--env</code> <a href=#hatch>root option</a> and the <code>HATCH_ENV</code> environment variable.</p> <p>If the environment provides matrices, then you may also provide leading arguments starting with a <code>+</code> or <code>-</code> to select or exclude certain variables, optionally followed by specific comma-separated values. For example, if you have the following configuration:</p> <div class="tabbed-set tabbed-alternate" data-tabs=2:2><input checked=checked id=pyprojecttoml_1 name=__tabbed_2 type=radio><input id=hatchtoml_1 name=__tabbed_2 type=radio><div class=tabbed-labels><label for=pyprojecttoml_1><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> pyproject.toml</label><label for=hatchtoml_1><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> hatch.toml</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[[tool.hatch.envs.test.matrix]]</span>
|
|
<span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"3.9"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.10"</span><span class=p>]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.14"</span><span class=p>,</span><span class=w> </span><span class=s2>"9000"</span><span class=p>]</span>
|
|
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[[envs.test.matrix]]</span>
|
|
<span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"3.9"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.10"</span><span class=p>]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.14"</span><span class=p>,</span><span class=w> </span><span class=s2>"9000"</span><span class=p>]</span>
|
|
</code></pre></div> </div> </div> </div> <p>then running:</p> <div class=highlight><pre><span></span><code>hatch run +py=3.10 -version=9000 test:pytest
|
|
</code></pre></div> <p>would execute <code>pytest</code> in the environments <code>test.py3.10-42</code> and <code>test.py3.10-3.14</code>. Note that <code>py</code> may be used as an alias for <code>python</code>.</p> <div class="admonition note"> <p class=admonition-title>Note</p> <p>Inclusions are treated as an intersection while exclusions are treated as a union i.e. an environment must match all of the included variables to be selected while matching any of the excluded variables will prevent selection.</p> </div> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch run [OPTIONS] [ENV:]ARGS...
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=hatch-self>hatch self<a class=headerlink href=#hatch-self title="Permanent link">¶</a></h2> <p>Manage Hatch</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch self [OPTIONS] COMMAND [ARGS]...
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-self-report>hatch self report<a class=headerlink href=#hatch-self-report title="Permanent link">¶</a></h3> <p>Generate a pre-populated GitHub issue.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch self report [OPTIONS]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--no-open</code>, <code>-n</code></td> <td>boolean</td> <td>Show the URL instead of opening it</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-self-restore>hatch self restore<a class=headerlink href=#hatch-self-restore title="Permanent link">¶</a></h3> <p>Restore the installation</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch self restore [OPTIONS] [ARGS]...
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=hatch-self-update>hatch self update<a class=headerlink href=#hatch-self-update title="Permanent link">¶</a></h3> <p>Install the latest version</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch self update [OPTIONS] [ARGS]...
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=hatch-shell>hatch shell<a class=headerlink href=#hatch-shell title="Permanent link">¶</a></h2> <p>Enter a shell within a project's environment.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch shell [OPTIONS] [ENV_NAME]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--name</code></td> <td>text</td> <td>N/A</td> <td>None</td> </tr> <tr> <td><code>--path</code></td> <td>text</td> <td>N/A</td> <td>None</td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=hatch-status>hatch status<a class=headerlink href=#hatch-status title="Permanent link">¶</a></h2> <p>Show information about the current environment.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch status [OPTIONS]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=hatch-test>hatch test<a class=headerlink href=#hatch-test title="Permanent link">¶</a></h2> <p>Run tests using the <code>hatch-test</code> environment matrix.</p> <p>If no filtering options are selected, then tests will be run in the first compatible environment found in the matrix with priority given to those matching the current interpreter.</p> <p>The <code>-i</code>/<code>--include</code> and <code>-x</code>/<code>--exclude</code> options may be used to include or exclude certain variables, optionally followed by specific comma-separated values, and may be selected multiple times. For example, if you have the following configuration:</p> <div class="tabbed-set tabbed-alternate" data-tabs=3:2><input checked=checked id=pyprojecttoml_2 name=__tabbed_3 type=radio><input id=hatchtoml_2 name=__tabbed_3 type=radio><div class=tabbed-labels><label for=pyprojecttoml_2><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> pyproject.toml</label><label for=hatchtoml_2><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> hatch.toml</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[[tool.hatch.envs.hatch-test.matrix]]</span>
|
|
<span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"3.9"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.10"</span><span class=p>]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.14"</span><span class=p>,</span><span class=w> </span><span class=s2>"9000"</span><span class=p>]</span>
|
|
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[[envs.hatch-test.matrix]]</span>
|
|
<span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"3.9"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.10"</span><span class=p>]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.14"</span><span class=p>,</span><span class=w> </span><span class=s2>"9000"</span><span class=p>]</span>
|
|
</code></pre></div> </div> </div> </div> <p>then running:</p> <div class=highlight><pre><span></span><code>hatch test -i py=3.10 -x version=9000
|
|
</code></pre></div> <p>would run tests in the environments <code>hatch-test.py3.10-42</code> and <code>hatch-test.py3.10-3.14</code>.</p> <p>The <code>-py</code>/<code>--python</code> option is a shortcut for specifying the inclusion <code>-i py=...</code>.</p> <div class="admonition note"> <p class=admonition-title>Note</p> <p>The inclusion option is treated as an intersection while the exclusion option is treated as a union i.e. an environment must match all of the included variables to be selected while matching any of the excluded variables will prevent selection.</p> </div> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch test [OPTIONS] [ARGS]...
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--randomize</code>, <code>-r</code></td> <td>boolean</td> <td>Randomize the order of test execution</td> <td><code>False</code></td> </tr> <tr> <td><code>--parallel</code>, <code>-p</code></td> <td>boolean</td> <td>Parallelize test execution</td> <td><code>False</code></td> </tr> <tr> <td><code>--retries</code></td> <td>integer</td> <td>Number of times to retry failed tests</td> <td>None</td> </tr> <tr> <td><code>--retry-delay</code></td> <td>float</td> <td>Seconds to wait between retries</td> <td>None</td> </tr> <tr> <td><code>--cover</code>, <code>-c</code></td> <td>boolean</td> <td>Measure code coverage</td> <td><code>False</code></td> </tr> <tr> <td><code>--cover-quiet</code></td> <td>boolean</td> <td>Disable coverage reporting after tests, implicitly enabling --cover</td> <td><code>False</code></td> </tr> <tr> <td><code>--all</code>, <code>-a</code></td> <td>boolean</td> <td>Test all environments in the matrix</td> <td><code>False</code></td> </tr> <tr> <td><code>--python</code>, <code>-py</code></td> <td>text</td> <td>The Python versions to test, equivalent to: -i py=...</td> <td>None</td> </tr> <tr> <td><code>--include</code>, <code>-i</code></td> <td>text</td> <td>The matrix variables to include</td> <td>None</td> </tr> <tr> <td><code>--exclude</code>, <code>-x</code></td> <td>text</td> <td>The matrix variables to exclude</td> <td>None</td> </tr> <tr> <td><code>--show</code>, <code>-s</code></td> <td>boolean</td> <td>Show information about environments in the matrix</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=hatch-version>hatch version<a class=headerlink href=#hatch-version title="Permanent link">¶</a></h2> <p>View or set a project's version.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>hatch version [OPTIONS] [DESIRED_VERSION]
|
|
</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">December 29, 2021</span> </span> <span class=md-source-file__fact> <span class=md-icon title=Contributors> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg> </span> <span>GitHub</span> <nav> <a href=https://github.com/ofek class=md-author title=@ofek> <img src="https://avatars.githubusercontent.com/u/9677399?v=4&size=72" alt=ofek> </a> </nav> </span> </aside> </article> </div> <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var tab,labels=set.querySelector(".tabbed-labels");for(tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=../about/ class="md-footer__link md-footer__link--prev" aria-label="Previous: About"> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> </div> <div class=md-footer__title> <span class=md-footer__direction> Previous </span> <div class=md-ellipsis> About </div> </div> </a> <a href=../../plugins/about/ class="md-footer__link md-footer__link--next" aria-label="Next: About"> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> About </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> Copyright © Ofek Lev 2017-present </div> <div> Logo by <a href=https://openai.com/dall-e-2/ target=_blank rel=noopener> DALL·E </a> and <a href=https://boriscrowther.com/ target=_blank rel=noopener> Boris Crowther </a> </div> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a> </div> <div class=md-social> <a href=https://github.com/ofek target=_blank rel=noopener title=github.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 480 512"><!-- Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"/></svg> </a> <a href=https://ofek.dev/words/ target=_blank rel=noopener title=ofek.dev class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><!-- Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M192 32c0 17.7 14.3 32 32 32 123.7 0 224 100.3 224 224 0 17.7 14.3 32 32 32s32-14.3 32-32C512 128.9 383.1 0 224 0c-17.7 0-32 14.3-32 32zm0 96c0 17.7 14.3 32 32 32 70.7 0 128 57.3 128 128 0 17.7 14.3 32 32 32s32-14.3 32-32c0-106-86-192-192-192-17.7 0-32 14.3-32 32zm-96 16c0-26.5-21.5-48-48-48S0 117.5 0 144v224c0 79.5 64.5 144 144 144s144-64.5 144-144-64.5-144-144-144h-16v96h16c26.5 0 48 21.5 48 48s-21.5 48-48 48-48-21.5-48-48V144z"/></svg> </a> <a href=https://twitter.com/Ofekmeister target=_blank rel=noopener title=twitter.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><!-- Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"/></svg> </a> <a href=https://www.linkedin.com/in/ofeklev/ target=_blank rel=noopener title=www.linkedin.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><!-- Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M416 32H31.9C14.3 32 0 46.5 0 64.3v383.4C0 465.5 14.3 480 31.9 480H416c17.6 0 32-14.5 32-32.3V64.3c0-17.8-14.4-32.3-32-32.3zM135.4 416H69V202.2h66.5V416zm-33.2-243c-21.3 0-38.5-17.3-38.5-38.5S80.9 96 102.2 96c21.2 0 38.5 17.3 38.5 38.5 0 21.3-17.2 38.5-38.5 38.5zm282.1 243h-66.4V312c0-24.8-.5-56.7-34.5-56.7-34.6 0-39.9 27-39.9 54.9V416h-66.4V202.2h63.7v29.2h.9c8.9-16.8 30.6-34.5 62.9-34.5 67.2 0 79.7 44.3 79.7 101.9V416z"/></svg> </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../..", "features": ["content.action.edit", "content.code.copy", "content.tabs.link", "content.tooltips", "navigation.expand", "navigation.footer", "navigation.instant", "navigation.sections", "navigation.tabs", "navigation.tabs.sticky"], "search": "../../assets/javascripts/workers/search.1e90e0fb.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script> <script src=../../assets/javascripts/bundle.e3055991.min.js></script> <script id=init-glightbox>const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});
|
|
document$.subscribe(() => { lightbox.reload() });
|
|
</script></body> </html> |