[{"data":1,"prerenderedAt":471},["ShallowReactive",2],{"navigation_docs":3,"-getting-started-installation":199,"-getting-started-installation-surround":466},[4,23,65,87,133,159,177],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":22},"Getting started","i-lucide-rocket","\u002Fgetting-started","1.getting-started",[10,14,18],{"title":11,"path":12,"stem":13},"Introduction","\u002Fgetting-started\u002Fintroduction","1.getting-started\u002F1.introduction",{"title":15,"path":16,"stem":17},"Installation","\u002Fgetting-started\u002Finstallation","1.getting-started\u002F2.installation",{"title":19,"path":20,"stem":21},"Quick start","\u002Fgetting-started\u002Fquick-start","1.getting-started\u002F3.quick-start",false,{"title":24,"icon":25,"path":26,"stem":27,"children":28,"page":22},"Guides","i-lucide-compass","\u002Fguides","2.guides",[29,33,37,41,45,49,53,57,61],{"title":30,"path":31,"stem":32},"Authenticate","\u002Fguides\u002Fauthentication","2.guides\u002F1.authentication",{"title":34,"path":35,"stem":36},"Work with several forges","\u002Fguides\u002Fmultiple-forges","2.guides\u002F2.multiple-forges",{"title":38,"path":39,"stem":40},"Configure from the environment","\u002Fguides\u002Fenvironment","2.guides\u002F3.environment",{"title":42,"path":43,"stem":44},"Receive webhooks","\u002Fguides\u002Fwebhooks","2.guides\u002F4.webhooks",{"title":46,"path":47,"stem":48},"Check what a forge supports","\u002Fguides\u002Fcapabilities","2.guides\u002F5.capabilities",{"title":50,"path":51,"stem":52},"Handle errors and rate limits","\u002Fguides\u002Ferrors","2.guides\u002F6.errors",{"title":54,"path":55,"stem":56},"Page through results","\u002Fguides\u002Fpagination","2.guides\u002F7.pagination",{"title":58,"path":59,"stem":60},"Browser bundles","\u002Fguides\u002Fbundling","2.guides\u002F8.bundling",{"title":62,"path":63,"stem":64},"Test your code","\u002Fguides\u002Ftesting","2.guides\u002F9.testing",{"title":66,"icon":67,"path":68,"stem":69,"children":70,"page":22},"Concepts","i-lucide-lightbulb","\u002Fconcepts","3.concepts",[71,75,79,83],{"title":72,"path":73,"stem":74},"Data model","\u002Fconcepts\u002Fdata-model","3.concepts\u002F1.data-model",{"title":76,"path":77,"stem":78},"Capabilities","\u002Fconcepts\u002Fcapabilities","3.concepts\u002F2.capabilities",{"title":80,"path":81,"stem":82},"Providers and factories","\u002Fconcepts\u002Fproviders","3.concepts\u002F3.providers",{"title":84,"path":85,"stem":86},"Events","\u002Fconcepts\u002Fevents","3.concepts\u002F4.events",{"title":88,"icon":89,"path":90,"stem":91,"children":92,"page":22},"Providers","i-lucide-server","\u002Fproviders","4.providers",[93,97,101,105,109,113,117,121,125,129],{"title":94,"path":95,"stem":96},"Azure DevOps","\u002Fproviders\u002Fazure-devops","4.providers\u002Fazure-devops",{"title":98,"path":99,"stem":100},"Bitbucket Cloud","\u002Fproviders\u002Fbitbucket","4.providers\u002Fbitbucket",{"title":102,"path":103,"stem":104},"Cursor Origin","\u002Fproviders\u002Fcursor-origin","4.providers\u002Fcursor-origin",{"title":106,"path":107,"stem":108},"Forgejo and Codeberg","\u002Fproviders\u002Fforgejo","4.providers\u002Fforgejo",{"title":110,"path":111,"stem":112},"Gitea","\u002Fproviders\u002Fgitea","4.providers\u002Fgitea",{"title":114,"path":115,"stem":116},"Gitee","\u002Fproviders\u002Fgitee","4.providers\u002Fgitee",{"title":118,"path":119,"stem":120},"GitHub","\u002Fproviders\u002Fgithub","4.providers\u002Fgithub",{"title":122,"path":123,"stem":124},"GitLab","\u002Fproviders\u002Fgitlab","4.providers\u002Fgitlab",{"title":126,"path":127,"stem":128},"pushin.eu","\u002Fproviders\u002Fpushin","4.providers\u002Fpushin",{"title":130,"path":131,"stem":132},"Tangled","\u002Fproviders\u002Ftangled","4.providers\u002Ftangled",{"title":134,"icon":135,"path":136,"stem":137,"children":138,"page":22},"Reference","i-lucide-book-marked","\u002Freference","5.reference",[139,143,147,151,155],{"title":140,"path":141,"stem":142},"Provider API","\u002Freference\u002Fprovider-api","5.reference\u002F1.provider-api",{"title":144,"path":145,"stem":146},"Capability matrix","\u002Freference\u002Fcapability-matrix","5.reference\u002F2.capability-matrix",{"title":148,"path":149,"stem":150},"Errors","\u002Freference\u002Ferrors","5.reference\u002F3.errors",{"title":152,"path":153,"stem":154},"Environment variables","\u002Freference\u002Fenvironment-variables","5.reference\u002F4.environment-variables",{"title":156,"path":157,"stem":158},"JSON Schemas","\u002Freference\u002Fjson-schemas","5.reference\u002F5.json-schemas",{"title":160,"icon":161,"path":162,"stem":163,"children":164,"page":22},"Examples","i-lucide-boxes","\u002Fexamples","6.examples",[165,169,173],{"title":166,"path":167,"stem":168},"Inbox CLI","\u002Fexamples\u002Finbox-cli","6.examples\u002F1.inbox-cli",{"title":170,"path":171,"stem":172},"Label bot","\u002Fexamples\u002Flabel-bot","6.examples\u002F2.label-bot",{"title":174,"path":175,"stem":176},"Release digest","\u002Fexamples\u002Frelease-digest","6.examples\u002F3.release-digest",{"title":178,"icon":179,"path":180,"stem":181,"children":182,"page":22},"Contributing","i-lucide-git-pull-request","\u002Fcontributing","7.contributing",[183,187,191,195],{"title":184,"path":185,"stem":186},"Contribution guide","\u002Fcontributing\u002Fguidelines","7.contributing\u002F1.guidelines",{"title":188,"path":189,"stem":190},"Write a provider","\u002Fcontributing\u002Fwrite-a-provider","7.contributing\u002F2.write-a-provider",{"title":192,"path":193,"stem":194},"Record fixtures","\u002Fcontributing\u002Frecord-fixtures","7.contributing\u002F3.record-fixtures",{"title":196,"path":197,"stem":198},"Contributors","\u002Fcontributing\u002Fcontributors","7.contributing\u002F4.contributors",{"id":200,"title":15,"body":201,"description":458,"extension":459,"links":460,"meta":461,"navigation":463,"path":16,"seo":464,"stem":17,"__hash__":465},"docs\u002F1.getting-started\u002F2.installation.md",{"type":202,"value":203,"toc":453},"minimark",[204,208,259,272,277,280,322,325,349,435,439,449],[205,206,207],"p",{},"Install the package from npm:",[209,210,211,229,239,249],"code-group",{},[212,213,219],"pre",{"className":214,"code":215,"filename":216,"language":217,"meta":218,"style":218},"language-sh shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","pnpm add forges\n","pnpm","sh","",[220,221,222],"code",{"__ignoreMap":218},[223,224,227],"span",{"class":225,"line":226},"line",1,[223,228,215],{},[212,230,233],{"className":214,"code":231,"filename":232,"language":217,"meta":218,"style":218},"npm install forges\n","npm",[220,234,235],{"__ignoreMap":218},[223,236,237],{"class":225,"line":226},[223,238,231],{},[212,240,243],{"className":214,"code":241,"filename":242,"language":217,"meta":218,"style":218},"yarn add forges\n","yarn",[220,244,245],{"__ignoreMap":218},[223,246,247],{"class":225,"line":226},[223,248,241],{},[212,250,253],{"className":214,"code":251,"filename":252,"language":217,"meta":218,"style":218},"bun add forges\n","bun",[220,254,255],{"__ignoreMap":218},[223,256,257],{"class":225,"line":226},[223,258,251],{},[205,260,261,264,265,268,269,271],{},[220,262,263],{},"forges"," requires Node.js 22.18 or later. The package is ESM only and ships its own types. It has no runtime dependencies and uses the global ",[220,266,267],{},"fetch",". To use another implementation, pass a ",[220,270,267],{}," option to a provider.",[273,274,276],"h2",{"id":275},"import-paths","Import paths",[205,278,279],{},"The root entry exports every provider and the shared helpers:",[212,281,285],{"className":282,"code":283,"language":284,"meta":218,"style":218},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","import { createForges, github } from 'forges'\n","ts",[220,286,287],{"__ignoreMap":218},[223,288,289,293,297,301,304,307,310,313,316,319],{"class":225,"line":226},[223,290,292],{"class":291},"s7zQu","import",[223,294,296],{"class":295},"sMK4o"," {",[223,298,300],{"class":299},"sTEyZ"," createForges",[223,302,303],{"class":295},",",[223,305,306],{"class":299}," github",[223,308,309],{"class":295}," }",[223,311,312],{"class":291}," from",[223,314,315],{"class":295}," '",[223,317,263],{"class":318},"sfazB",[223,320,321],{"class":295},"'\n",[205,323,324],{},"Each provider also has its own subpath. A bundle that imports one subpath contains one forge:",[212,326,328],{"className":282,"code":327,"language":284,"meta":218,"style":218},"import { github } from 'forges\u002Fgithub'\n",[220,329,330],{"__ignoreMap":218},[223,331,332,334,336,338,340,342,344,347],{"class":225,"line":226},[223,333,292],{"class":291},[223,335,296],{"class":295},[223,337,306],{"class":299},[223,339,309],{"class":295},[223,341,312],{"class":291},[223,343,315],{"class":295},[223,345,346],{"class":318},"forges\u002Fgithub",[223,348,321],{"class":295},[350,351,352,365],"table",{},[353,354,355],"thead",{},[356,357,358,362],"tr",{},[359,360,361],"th",{},"Subpath",[359,363,364],{},"Contents",[366,367,368,386,398,411,423],"tbody",{},[356,369,370,380],{},[371,372,373,375,376,379],"td",{},[220,374,346],{},", ",[220,377,378],{},"forges\u002Fgitlab"," and so on",[371,381,382,383],{},"One provider. See ",[384,385,88],"a",{"href":90},[356,387,388,393],{},[371,389,390],{},[220,391,392],{},"forges\u002Fenv",[371,394,395],{},[384,396,397],{"href":39},"Configure providers from the environment",[356,399,400,405],{},[371,401,402],{},[220,403,404],{},"forges\u002Ffake",[371,406,407,408],{},"An in-memory forge for ",[384,409,410],{"href":63},"tests",[356,412,413,418],{},[371,414,415],{},[220,416,417],{},"forges\u002Ftesting",[371,419,420,421],{},"Fixture replay and webhook signing for ",[384,422,410],{"href":63},[356,424,425,430],{},[371,426,427],{},[220,428,429],{},"forges\u002Fschema",[371,431,432,434],{},[384,433,156],{"href":157}," for the model types",[273,436,438],{"id":437},"browsers","Browsers",[205,440,441,442,445,446,448],{},"Every provider except pushin.eu has a Lite factory, such as ",[220,443,444],{},"githubLite()",", that leaves out webhook code. Use it in browser code. Read ",[384,447,58],{"href":59}," for sizes and details.",[450,451,452],"style",{},"html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}",{"title":218,"searchDepth":454,"depth":454,"links":455},2,[456,457],{"id":275,"depth":454,"text":276},{"id":437,"depth":454,"text":438},"Add forges to your project.","md",null,{"icon":462},"i-lucide-download",true,{"title":15,"description":458},"ClUGihfus-ImyUzdqyRyEcFfzN0YYr7_Aik25ZMeDTs",[467,469],{"title":11,"path":12,"stem":13,"description":468,"children":-1},"What forges is, and what you can build with it.",{"title":19,"path":20,"stem":21,"description":470,"children":-1},"Read an issue, write a comment and add a second forge.",1791296693710]