[{"data":1,"prerenderedAt":389},["ShallowReactive",2],{"navigation_docs":3,"-getting-started-quickstart":114,"-getting-started-quickstart-surround":384},[4,23,85,99],{"title":5,"path":6,"stem":7,"children":8},"Getting Started","\u002Fgetting-started","1.getting-started",[9,13,18],{"title":10,"path":6,"stem":11,"icon":12},"Getting started","1.getting-started\u002Findex","i-lucide-rocket",{"title":14,"path":15,"stem":16,"icon":17},"Try the demo","\u002Fgetting-started\u002Ftry-the-demo","1.getting-started\u002F1.try-the-demo","i-lucide-monitor-play",{"title":19,"path":20,"stem":21,"icon":22},"Quickstart","\u002Fgetting-started\u002Fquickstart","1.getting-started\u002F2.quickstart","i-lucide-play",{"title":24,"path":25,"stem":26,"children":27},"Guides","\u002Fguides","2.guides",[28,31,37,42,47,53,58,63,68,74,80],{"title":24,"path":25,"stem":29,"icon":30},"2.guides\u002Findex","i-lucide-map",{"title":32,"path":33,"stem":34,"icon":35,"group":36},"Connect a GitHub repository","\u002Fguides\u002Fconnect-a-github-repository","2.guides\u002F01.connect-a-github-repository","i-lucide-git-branch","Connect a project",{"title":38,"path":39,"stem":40,"icon":41,"group":36},"Analyze a project without GitHub","\u002Fguides\u002Fanalyze-a-project-without-github","2.guides\u002F02.analyze-a-project-without-github","i-lucide-upload",{"title":43,"path":44,"stem":45,"icon":46,"group":36},"Exclude dependency scopes","\u002Fguides\u002Fexclude-dependency-scopes","2.guides\u002F04.exclude-dependency-scopes","i-lucide-filter",{"title":48,"path":49,"stem":50,"icon":51,"group":52},"Scan from GitHub Actions","\u002Fguides\u002Fscan-from-github-actions","2.guides\u002F05.scan-from-github-actions","i-lucide-workflow","Automate",{"title":54,"path":55,"stem":56,"icon":57,"group":52},"Scan from another CI","\u002Fguides\u002Fscan-from-another-ci","2.guides\u002F06.scan-from-another-ci","i-lucide-square-terminal",{"title":59,"path":60,"stem":61,"icon":62,"group":52},"Manage API keys","\u002Fguides\u002Fmanage-api-keys","2.guides\u002F07.manage-api-keys","i-lucide-key-round",{"title":64,"path":65,"stem":66,"icon":67,"group":52},"Create many projects at once","\u002Fguides\u002Fcreate-many-projects-at-once","2.guides\u002F08.create-many-projects-at-once","i-lucide-layers",{"title":69,"path":70,"stem":71,"icon":72,"group":73},"Export reports and SBOMs","\u002Fguides\u002Fexport-reports-and-sboms","2.guides\u002F11.export-reports-and-sboms","i-lucide-download","Act on the results",{"title":75,"path":76,"stem":77,"icon":78,"group":79},"Organizations and plans","\u002Fguides\u002Forganizations-and-plans","2.guides\u002F13.organizations-and-plans","i-lucide-building-2","Organization and team",{"title":81,"path":82,"stem":83,"icon":84,"group":79},"Invite your team","\u002Fguides\u002Finvite-your-team","2.guides\u002F14.invite-your-team","i-lucide-users",{"title":86,"path":87,"stem":88,"children":89},"Core Concepts","\u002Fcore-concepts","3.core-concepts",[90,94],{"title":91,"path":87,"stem":92,"icon":93},"Core concepts","3.core-concepts\u002Findex","i-lucide-lightbulb",{"title":95,"path":96,"stem":97,"icon":98},"The health score","\u002Fcore-concepts\u002Fhealth-score","3.core-concepts\u002F1.health-score","i-lucide-gauge",{"title":100,"path":101,"stem":102,"children":103},"Reference","\u002Freference","5.reference",[104,107],{"title":100,"path":101,"stem":105,"icon":106},"5.reference\u002Findex","i-lucide-book-marked",{"title":108,"path":109,"stem":110,"children":111,"icon":113},"Supported ecosystems","\u002Freference\u002Fecosystems","5.reference\u002F1.ecosystems\u002Findex",[112],{"title":108,"path":109,"stem":110,"icon":113},"i-lucide-package",{"id":115,"title":19,"body":116,"description":377,"extension":378,"links":379,"meta":380,"navigation":381,"path":20,"seo":382,"stem":21,"__hash__":383},"docs\u002F1.getting-started\u002F2.quickstart.md",{"type":117,"value":118,"toc":368},"minimark",[119,124,128,136,144,147,151,161,178,184,188,191,201,207,210,224,227,304,311,316,323,328,332,335,342,349,352,356],[120,121,123],"h2",{"id":122},"before-you-start","Before you start",[125,126,127],"p",{},"You need a GitHub account. Deptools reads your build files from GitHub through\nits own GitHub App. You can sign in with GitHub, or sign up with an email\naddress and connect GitHub afterwards.",[125,129,130,131,135],{},"You also need a repository that declares its dependencies in a supported build\nfile. Maven, Gradle, npm, sbt and Composer are supported. See\n",[132,133,134],"a",{"href":109},"supported ecosystems"," for the exact files that are read.",[137,138,139,140,143],"note",{},"If your code is not on GitHub.com, the GitHub path does not apply. Your pipeline\npushes the build files to Deptools instead. That path requires the Pro plan. See\n",[132,141,142],{"href":39},"analyze a project without GitHub",".",[125,145,146],{},"On the Free plan you can create up to 10 projects on public repositories, and\neach project can be scanned once every 3 hours. You can create several projects\nfrom the same repository, one per module or one per scope configuration, and\neach one counts toward the limit.",[120,148,150],{"id":149},"create-your-account","Create your account",[125,152,153,154,160],{},"Open the ",[132,155,159],{"href":156,"rel":157},"https:\u002F\u002Fdeptools.io\u002Fauth\u002Fregister",[158],"nofollow","sign up page"," and create an account\nin one of two ways:",[162,163,164,172],"ul",{},[165,166,167,171],"li",{},[168,169,170],"strong",{},"With GitHub",". You authorize Deptools once, and your GitHub account is\nconnected at the same time.",[165,173,174,177],{},[168,175,176],{},"With an email address",". Deptools sends you a six digit code to confirm the\naddress. If it does not arrive, check your spam folder. You can connect GitHub\nlater, from the project creation screen.",[125,179,180,181,143],{},"Deptools creates your personal organization for you. You can add another\norganization later if needed. See\n",[132,182,183],{"href":76},"organizations and plans",[120,185,187],{"id":186},"add-your-first-project","Add your first project",[125,189,190],{},"Adding a project takes three steps: authorize the GitHub App, pick the\nrepository, then configure what gets analyzed. A repository that declares\nseveral modules adds a fourth, choosing which one to analyze.",[125,192,193,194,197,198,143],{},"From your projects page, open ",[168,195,196],{},"Connect a repository",", then choose\n",[168,199,200],{},"GitHub repository",[202,203],"u-color-mode-image",{"alt":204,"dark":205,"light":206},"Project source step with GitHub repository and Upload from CI","\u002Fimages\u002Fdocs\u002Fgetting-started\u002Fquickstart-1-project-source-dark.webp","\u002Fimages\u002Fdocs\u002Fgetting-started\u002Fquickstart-1-project-source-light.webp",[125,208,209],{},"The first time, Deptools asks you to install its GitHub App. Signing in with\nGitHub is not enough: that step identifies you, but it grants no access to any code.\nThe App is what reads your build files, and you decide what it can reach. On\nGitHub, install it on your account or on an organization, then grant it access\nto all repositories or to a list you choose.",[125,211,212,213,216,217,220,221,223],{},"Come back to Deptools and use ",[168,214,215],{},"Refresh",". Only the repositories you granted\nappear in the list. If one is missing, use ",[168,218,219],{},"Manage access on GitHub"," to add\nit. Private repositories are listed only on the Pro plan, whatever you granted\nthe App. ",[132,222,32],{"href":33},"\ncovers the permissions the App requests, adding a repository later, and private\nrepositories.",[125,225,226],{},"Pick a repository, then configure the project:",[228,229,230,243],"table",{},[231,232,233],"thead",{},[234,235,236,240],"tr",{},[237,238,239],"th",{},"Field",[237,241,242],{},"What it does",[244,245,246,262,272,282],"tbody",{},[234,247,248,254],{},[249,250,251],"td",{},[168,252,253],{},"Project name",[249,255,256,257,261],{},"The name shown in Deptools. Prefilled with ",[258,259,260],"code",{},"owner\u002Frepo",", and free to change.",[234,263,264,269],{},[249,265,266],{},[168,267,268],{},"Branch",[249,270,271],{},"The branch whose build files are read. The default branch is preselected.",[234,273,274,279],{},[249,275,276],{},[168,277,278],{},"Ecosystem",[249,280,281],{},"Shown only when the repository declares several. The project analyzes the one you pick.",[234,283,284,289],{},[249,285,286],{},[168,287,288],{},"Dependency scopes to analyze",[249,290,291,292,295,296,299,300,303],{},"The dependency scopes considered in your graph. Every scope is selected by default except the test one, which the interface names ",[258,293,294],{},"Test"," on the JVM, ",[258,297,298],{},"Development"," on npm and ",[258,301,302],{},"Require Dev"," on Composer.",[125,305,306,307,310],{},"Scope choices are made once, at creation. Read\n",[132,308,309],{"href":44},"exclude dependency scopes"," before you\nconfirm.",[202,312],{"alt":313,"dark":314,"light":315},"Project configuration with name, branch and dependency scopes","\u002Fimages\u002Fdocs\u002Fgetting-started\u002Fquickstart-2-project-configuration-dark.webp","\u002Fimages\u002Fdocs\u002Fgetting-started\u002Fquickstart-2-project-configuration-light.webp",[125,317,318,319,322],{},"If the repository declares several modules, Deptools detects them and asks you\nto choose one. ",[168,320,321],{},"Entire repository"," analyzes them all in a single project. It\nappears only when the repository root holds a build file of its own. To follow\neach module separately, create one project per module.",[202,324],{"alt":325,"dark":326,"light":327},"Module selection step, with the entire repository option above the detected modules","\u002Fimages\u002Fdocs\u002Fgetting-started\u002Fquickstart-3-project-module-dark.webp","\u002Fimages\u002Fdocs\u002Fgetting-started\u002Fquickstart-3-project-module-light.webp",[120,329,331],{"id":330},"run-the-scan","Run the scan",[125,333,334],{},"You do not have to start the first scan. It runs as soon as the project is\ncreated.",[125,336,337,338,341],{},"The project card shows ",[168,339,340],{},"Scan in progress"," while it runs. This usually takes a\nfew minutes. Deptools reads the build files, resolves the full dependency tree\nincluding transitive dependencies, then computes the metrics and the scores.",[125,343,344,345,348],{},"When the scan completes, the card shows the health score. ",[168,346,347],{},"View report"," opens\nthe dashboard.",[125,350,351],{},"If the scan fails, the card says so and the project page gives the reason.",[120,353,355],{"id":354},"next-steps","Next steps",[162,357,358,363],{},[165,359,360,362],{},[132,361,95],{"href":96}," explains where that number\ncomes from.",[165,364,365,367],{},[132,366,48],{"href":49}," runs a scan\non every push, and fails the build when your dependencies get worse.",{"title":369,"searchDepth":370,"depth":370,"links":371},"",2,[372,373,374,375,376],{"id":122,"depth":370,"text":123},{"id":149,"depth":370,"text":150},{"id":186,"depth":370,"text":187},{"id":330,"depth":370,"text":331},{"id":354,"depth":370,"text":355},"Create an account, connect a repository, and get your first health score.","md",null,{},{"icon":22},{"title":19,"description":377},"npSQ2XpNfVqCip62elddSi8TO2yG6StTE0sh1BFN0a8",[385,387],{"title":14,"path":15,"stem":16,"description":386,"icon":17,"children":-1},"See a complete analysis, with every tab and the dependency graph, without creating an account.",{"title":24,"path":25,"stem":29,"description":388,"icon":30,"children":-1},"Task based instructions for connecting repositories, scanning from CI, managing API keys, exports, organizations and team access.",1787263156395]