A Node.js module and CLI for interacting with SCANOSS APIs and Engine. Scan your codebase for open-source components, dependencies, and licence compliance.
SCANOSS-JS can be installed globally on your system and used as a CLI,
or added to your Node.js project as a dependency.
Prerequisites
Before you begin, ensure you have the following installed:
Node.js and npm (Node.js v14 or later recommended) —
installing Node.js includes npm
Installation
CLI Installation
To install the SCANOSS CLI globally on your system:
npm install -g scanoss
SDK Installation
To install the SCANOSS SDK as a dependency in your Node.js project:
npm install scanoss
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"SCANOSS documentation","colors":{"primary":"#FF6A1A","light":"#FF6A1A","dark":"#FF6A1A"},"logo":{"light":"https://mintcdn.com/scanoss/9UP7eHL2Z_rQPx8l/scanoss-logo-horizontal-positive.svg?fit=max\u0026auto=format\u0026n=9UP7eHL2Z_rQPx8l\u0026q=85\u0026s=686c4487013423ef804e2e83983c76ef","dark":"https://mintcdn.com/scanoss/9UP7eHL2Z_rQPx8l/scanoss-logo-horizontal-negative.svg?fit=max\u0026auto=format\u0026n=9UP7eHL2Z_rQPx8l\u0026q=85\u0026s=03cf2002f3fff2726f8e9b19bb2781ec","href":"https://scanoss.com"},"favicon":"https://mintcdn.com/scanoss/SuvZQ2xWfRUv4OAb/scan-favicon.png?fit=max\u0026auto=format\u0026n=SuvZQ2xWfRUv4OAb\u0026q=85\u0026s=4f02839460dfdc66102d3b028b507df6","appearance":{"default":"system","strict":false},"footer":{"socials":{"x":"https://x.com/SCANOSS_","github":"https://github.com/scanoss","linkedin":"https://es.linkedin.com/company/scanoss"}},"seo":{"indexing":"all"},"fonts":{"heading":{"family":"Space Grotesk","weight":700,"format":"woff2"},"body":{"family":"Space Grotesk","format":"woff2"}},"integrations":{"ga4":{"measurementId":"G-NWY31TXG8Y"}},"banner":{"content":"**Earnie is here** — SCANOSS's major release for AI governance, cryptography, PQC readiness, and open source compliance. [Watch the release demo →](https://youtu.be/MKgIpH4bEQ4?si=wXECS3umWGx11mB7)","dismissible":true},"contextual":{"options":["copy","view","claude","chatgpt","cursor","vscode","mcp"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"scanoss","hasAudioNarration":false,"actualSubdomain":"scanoss","customDomains":["docs.scanoss.com"],"gitSource":{"type":"github","owner":"scanoss","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b006b4ba30465d2cf4057e7","clientVersion":"0.0.4269","searchFilterCounts":[{"language":"default","tag":"Earnie","count":163},{"language":"default","tag":"API Reference","count":137},{"language":"default","tag":"Guides","count":84},{"language":"default","tag":"Developer Tools","count":70},{"language":"default","tag":"API reference","count":48},{"language":"default","tag":"v3 endpoints","count":47},{"language":"default","tag":"Scans","count":44},{"language":"default","tag":"scans","count":44},{"language":"default","tag":"Policies","count":22},{"language":"default","tag":"Findings","count":21}]},"assistantConfig":{"enableStarterQuestions":true,"deflection":{"enabled":true,"email":"support@scanoss.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"695fa5b6a879c7d6b0e8a169","deploymentId":"68551e34bde804c6773f4df2","questionText":"Cannot import/export projects?","status":"active","generatedBy":"manual","createdAt":"2026-01-08T12:40:22.697Z","updatedAt":"2026-01-08T12:40:22.697Z","__v":0},{"_id":"695fa5a4a879c7d6b0e8a064","deploymentId":"68551e34bde804c6773f4df2","questionText":"Dependency files not detected during scan?","status":"active","generatedBy":"manual","createdAt":"2026-01-08T12:40:04.675Z","updatedAt":"2026-01-08T12:40:04.675Z","__v":0},{"_id":"695fa566a879c7d6b0e89d1e","deploymentId":"68551e34bde804c6773f4df2","questionText":"How do I configure the SCANOSS API key?","status":"active","generatedBy":"manual","createdAt":"2026-01-08T12:39:02.662Z","updatedAt":"2026-01-08T12:39:02.662Z","__v":0}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#banner{background-color:#ff6a1a!important;color:#ffffff!important}html:not(.dark) #background-color,html:not(.dark) #navbar-transition{background-color:#f4f6f9!important}html:not(.dark) h1{color:#081320!important}html:not(.dark) nav a[aria-current=\"page\"]{background-color:rgba(8, 19, 32, 0.1)!important}html:not(.dark) .chat-assistant-floating-input .bg-background-light,html:not(.dark) .chat-assistant-floating-input::before,html:not(.dark) #assistant-entry,html:not(.dark) #chat-assistant-sheet,html:not(.dark) #chat-assistant-sheet .bg-background-light{background-color:#f4f6f9!important}html.dark #background-color,html.dark #navbar-transition{background-color:#081320!important}html.dark h1,html.dark .prose :where(h1,h2,h3,h4,h5,h6),html.dark .prose :where(p,li,td,th):not(svg *){color:#ffffff!important}html.dark nav a[aria-current=\"page\"]{background-color:rgba(255, 106, 26, 0.15)!important}html.dark .chat-assistant-floating-input .dark\\:bg-background-dark,html.dark .chat-assistant-floating-input::before,html.dark #assistant-entry,html.dark #chat-assistant-sheet,html.dark #chat-assistant-sheet .dark\\:bg-background-dark{background-color:#081320!important}span[style*=\"radial-gradient\"]{display:none!important}nav#sidebar .sticky.top-0.h-8{display:none!important}#sidebar #navigation-items{padding-top:2rem}.eyebrow{color:#ff6a1a!important}nav a.text-primary{color:#ff6a1a!important}"}]}
{"page":{"pagePath":"en/latest/cli/scanoss-js/installation","slug":"/en/latest/cli/scanoss-js/installation","pageMetadata":{"title":"Installation","sidebarTitle":"Installation","description":"A Node.js module and CLI for interacting with SCANOSS APIs and Engine. Scan your codebase for open-source components, dependencies, and licence compliance.","href":"/en/latest/cli/scanoss-js/installation"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"A Node.js module and CLI for interacting with SCANOSS APIs and Engine. Scan your codebase for open-source components, dependencies, and licence compliance.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,OptimizedFrame}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!OptimizedFrame)_missingMdxReference(`OptimizedFrame`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:_jsx(OptimizedFrame,{width:`100%`,style:{aspectRatio:`16/9`,borderRadius:`8px`,marginTop:`12px`},src:`https://www.youtube.com/embed/iXvoxtsTdiM?si=Ba3x00GnG6Tu8CnT`,title:`SCANOSS GitHub Actions Integration`,frameBorder:`0`,allow:`accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; \npicture-in-picture`,allowFullScreen:true})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`https://github.com/scanoss/scanoss.js`,children:`SCANOSS-JS`}),` can be installed globally on your system and used as a CLI,\nor added to your Node.js project as a dependency.`]}),`\n`,_jsx(Heading,{level:`2`,id:`prerequisites`,children:`Prerequisites`}),`\n`,_jsx(_components.p,{children:`Before you begin, ensure you have the following installed:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`https://nodejs.org/`,children:`Node.js and npm`}),` (Node.js v14 or later recommended) —\ninstalling Node.js includes npm`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`installation`,children:`Installation`}),`\n`,_jsx(Heading,{level:`3`,id:`cli-installation`,children:`CLI Installation`}),`\n`,_jsx(_components.p,{children:`To install the SCANOSS CLI globally on your system:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`npm`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -g`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` scanoss`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`sdk-installation`,children:`SDK Installation`}),`\n`,_jsx(_components.p,{children:`To install the SCANOSS SDK as a dependency in your Node.js project:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`npm`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` scanoss`})]}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Installation","sidebarTitle":"Installation","description":"A Node.js module and CLI for interacting with SCANOSS APIs and Engine. Scan your codebase for open-source components, dependencies, and licence compliance.","href":"/en/latest/cli/scanoss-js/installation"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Prerequisites","slug":"prerequisites","depth":2,"children":[]},{"title":"Installation","slug":"installation","depth":2,"children":[{"title":"CLI Installation","slug":"cli-installation","depth":3,"children":[]},{"title":"SDK Installation","slug":"sdk-installation","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"scanoss","siteName":"SCANOSS documentation","title":"Installation - SCANOSS documentation","navMaps":{"firstHrefInVersion":{"v2":{"href":"/en/latest/cli/scanoss-go/installation","matchLevel":1},"v1":{"href":"/en/latest/cli/scanoss-js/installation","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-06T15:29:26.027Z","originalFileLocation":"en/latest/cli/scanoss-js/installation.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"A Node.js module and CLI for interacting with SCANOSS APIs and Engine. Scan your codebase for open-source components, dependencies, and licence compliance.\">\u003cmeta data-mint-head name=\"application-name\" content=\"SCANOSS documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/scanoss/KZfWE-Zg_gP00ddS/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/scanoss/KZfWE-Zg_gP00ddS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/scanoss/KZfWE-Zg_gP00ddS/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/scanoss/KZfWE-Zg_gP00ddS/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/scanoss/KZfWE-Zg_gP00ddS/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/scanoss/KZfWE-Zg_gP00ddS/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/scanoss/KZfWE-Zg_gP00ddS/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/scanoss/KZfWE-Zg_gP00ddS/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/scanoss/KZfWE-Zg_gP00ddS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Installation - SCANOSS documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"A Node.js module and CLI for interacting with SCANOSS APIs and Engine. Scan your codebase for open-source components, dependencies, and licence compliance.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SCANOSS documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.scanoss.com/en/latest/cli/scanoss-js/installation\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://scanoss.mintlify.site/_mintlify/api/og/v2?division=SCANOSS-JS\u0026amp;title=Installation\u0026amp;description=A+Node.js+module+and+CLI+for+interacting+with+SCANOSS+APIs+and+Engine.+Scan+your+codebase+for+open-source+components%2C+dependencies%2C+and+licence+compliance.\u0026amp;theme=27507c7cd4c9b47ed5abe8b8\u0026amp;signature=4b9178dcd8ef4fd32ff65f550c20776c6822fadcfc69d4eaec319d0cc6d20445\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Installation - SCANOSS documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"A Node.js module and CLI for interacting with SCANOSS APIs and Engine. Scan your codebase for open-source components, dependencies, and licence compliance.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://scanoss.mintlify.site/_mintlify/api/og/v2?division=SCANOSS-JS\u0026amp;title=Installation\u0026amp;description=A+Node.js+module+and+CLI+for+interacting+with+SCANOSS+APIs+and+Engine.+Scan+your+codebase+for+open-source+components%2C+dependencies%2C+and+licence+compliance.\u0026amp;theme=27507c7cd4c9b47ed5abe8b8\u0026amp;signature=4b9178dcd8ef4fd32ff65f550c20776c6822fadcfc69d4eaec319d0cc6d20445\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/scanoss/KZfWE-Zg_gP00ddS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SCANOSS documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF6A1A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.scanoss.com/en/latest/cli/scanoss-js/installation\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/latest/cli/scanoss-js/installation.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.scanoss.com/#organization\",\"name\":\"SCANOSS documentation\",\"url\":\"https://docs.scanoss.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/scanoss/9UP7eHL2Z_rQPx8l/scanoss-logo-horizontal-positive.svg?fit=max\u0026auto=format\u0026n=9UP7eHL2Z_rQPx8l\u0026q=85\u0026s=686c4487013423ef804e2e83983c76ef\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.scanoss.com#website\",\"name\":\"SCANOSS documentation\",\"url\":\"https://docs.scanoss.com\",\"publisher\":{\"@id\":\"https://docs.scanoss.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.scanoss.com/en/latest/cli/scanoss-js/installation#webpage\",\"url\":\"https://docs.scanoss.com/en/latest/cli/scanoss-js/installation\",\"name\":\"Installation\",\"description\":\"A Node.js module and CLI for interacting with SCANOSS APIs and Engine. Scan your codebase for open-source components, dependencies, and licence compliance.\",\"dateModified\":\"2026-10-06T15:29:26.027Z\",\"isPartOf\":{\"@id\":\"https://docs.scanoss.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.scanoss.com/en/latest/cli/scanoss-js/installation#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.scanoss.com/en/latest/cli/scanoss-js/installation#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"CLI Tools\",\"item\":\"https://docs.scanoss.com/en/latest/cli/scanoss-py/installation\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Installation\",\"item\":\"https://docs.scanoss.com/en/latest/cli/scanoss-js/installation\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.scanoss.com/en/latest/cli/scanoss-js/installation#article\",\"headline\":\"Installation\",\"name\":\"Installation\",\"description\":\"A Node.js module and CLI for interacting with SCANOSS APIs and Engine. Scan your codebase for open-source components, dependencies, and licence compliance.\",\"url\":\"https://docs.scanoss.com/en/latest/cli/scanoss-js/installation\",\"mainEntityOfPage\":{\"@id\":\"https://docs.scanoss.com/en/latest/cli/scanoss-js/installation#webpage\"},\"dateModified\":\"2026-10-06T15:29:26.027Z\",\"publisher\":{\"@id\":\"https://docs.scanoss.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.scanoss.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SCANOSS documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"SCANOSS documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/en/latest/cli/scanoss-js/installation.md","siteName":"SCANOSS documentation","nav":{"global":null,"versions":[{"version":"v2","default":true,"pages":[{"title":"v2","href":"/en/latest/cli/scanoss-go/installation"}]},{"version":"v1","tabs":[{"tab":"Guides","hidden":false,"groups":[{"group":"Introduction \u0026 Overview","expanded":false,"pages":[{"title":"What is SCANOSS?","href":"/en/latest/introduction/what-is-scanoss"},{"group":"Core Use Cases","expanded":false,"pages":[{"title":"Open Source in AI-Generated Code","sidebarTitle":"Open Source in AI-Generated Code","href":"/en/latest/introduction/use-cases/oss-in-ai-gen-code"},{"title":"Cryptography Detection","sidebarTitle":"Cryptography Detection","href":"/en/latest/introduction/use-cases/crypto-detection"},{"title":"OSS Licence Compliance","sidebarTitle":"OSS Licence Compliance","href":"/en/latest/introduction/use-cases/oss-license-compliance"}]},{"title":"Platform Architecture Overview","href":"/en/latest/introduction/platform-architecture-overview"},{"title":"Initial API Configuration","sidebarTitle":"Initial API Configuration","href":"/en/latest/introduction/initial-api-configuration"}]},{"group":"Getting Started","expanded":false,"pages":[{"title":"Components Overview","sidebarTitle":"Components Overview","href":"/en/latest/getting-started/components-overview"},{"title":"Understanding Scan Results","sidebarTitle":"Understanding Scan Results","href":"/en/latest/getting-started/understanding-scan-results"},{"title":"Declaring Components","sidebarTitle":"Declaring Components","href":"/en/latest/getting-started/declaring-components"}]},{"group":"Installation \u0026 Deployment","expanded":false,"pages":[{"group":"On-Premise","expanded":false,"pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/en/latest/installation/on-prem/overview"},{"group":"Deployment Guide","expanded":false,"pages":[{"title":"Hardware requirements","sidebarTitle":"Hardware requirements","href":"/en/latest/installation/on-prem/deployment-guide/hardware-requirements"},{"title":"Prepare the environment","sidebarTitle":"Prepare the environment","href":"/en/latest/installation/on-prem/deployment-guide/prepare-environment"},{"title":"Install applications","sidebarTitle":"Install applications","href":"/en/latest/installation/on-prem/deployment-guide/install-applications"},{"title":"Install Knowledge Base","sidebarTitle":"Install Knowledge Base","href":"/en/latest/installation/on-prem/deployment-guide/install-knowledge-base"},{"title":"Verify installation","sidebarTitle":"Verify installation","href":"/en/latest/installation/on-prem/deployment-guide/verify-installation"},{"group":"Configuration","expanded":false,"pages":[{"title":"API service management","sidebarTitle":"API service management","href":"/en/latest/installation/on-prem/configuration/api-service-management"},{"title":"API configuration","sidebarTitle":"API configuration","href":"/en/latest/installation/on-prem/configuration/api-configuration"}]}]},{"title":"KB update guide","sidebarTitle":"KB update guide","href":"/en/latest/installation/on-prem/kb-update-guide"},{"title":"KB Docker example","href":"/en/latest/installation/on-prem/local-kb-docker-example"}]},{"title":"Cloud deployment","sidebarTitle":"Cloud deployment","href":"/en/latest/installation/cloud-deployment"}]},{"group":"Configuration \u0026 Administration","expanded":false,"pages":[{"title":"Proxy Configuration","sidebarTitle":"Proxy Configuration","href":"/en/latest/configuration/proxy-configuration"},{"title":"Certificate Management","sidebarTitle":"Certificate Management","href":"/en/latest/configuration/certificate-management"}]},{"group":"Integrations \u0026 CI/CD","expanded":false,"pages":[{"title":"Pre-Commit Hooks","sidebarTitle":"Pre-Commit Hooks","href":"/en/latest/integrations/pre-commit-hooks"},{"title":"GitHub Actions","sidebarTitle":"GitHub Actions","href":"/en/latest/integrations/github-actions"},{"title":"Azure DevOps","sidebarTitle":"Azure DevOps","href":"/en/latest/integrations/azure-devops"},{"title":"Jenkins","sidebarTitle":"Jenkins","href":"/en/latest/integrations/jenkins"},{"title":"GitLab","sidebarTitle":"GitLab","href":"/en/latest/integrations/gitlab"},{"title":"SonarQube","sidebarTitle":"SonarQube","href":"/en/latest/integrations/sonarqube"},{"title":"Dependency-Track","sidebarTitle":"Dependency-Track","href":"/en/latest/integrations/dependency-track"},{"title":"OSS Review Toolkit (ORT)","sidebarTitle":"OSS Review Toolkit (ORT)","href":"/en/latest/integrations/oss-review-toolkit"}]},{"group":"Engine \u0026 LDB","expanded":false,"pages":[{"group":"SCANOSS Engine","expanded":false,"pages":[{"title":"Scanning a file or directory","sidebarTitle":"Scanning a file or directory","href":"/en/latest/core/engine/scanning-file-or-directory"},{"title":"Command parameters and flags","sidebarTitle":"Command parameters and flags","href":"/en/latest/core/engine/command-parameters-flags"}]},{"title":"SCANOSS LDB","sidebarTitle":"SCANOSS LDB","href":"/en/latest/core/scanoss-ldb"}]},{"group":"CLI Tools","expanded":false,"pages":[{"group":"SCANOSS-PY","expanded":false,"pages":[{"title":"Installation","sidebarTitle":"Installation","href":"/en/latest/cli/scanoss-py/installation"},{"title":"Scanning Your Project","sidebarTitle":"Scanning","href":"/en/latest/cli/scanoss-py/scanning-your-project"},{"title":"Output Formats","sidebarTitle":"Output Formats","href":"/en/latest/cli/scanoss-py/output-formats"},{"title":"Converting Results","sidebarTitle":"Converting Results","href":"/en/latest/cli/scanoss-py/converting-results"},{"title":"Commands \u0026 Arguments","sidebarTitle":"Commands \u0026 Arguments","href":"/en/latest/cli/scanoss-py/commands-and-arguments"},{"title":"Proxy and Certificate Options","sidebarTitle":"Proxy and Certificate Options","href":"/en/latest/cli/scanoss-py/proxy-and-certificate-options"},{"title":"Using Docker","sidebarTitle":"Using Docker","href":"/en/latest/cli/scanoss-py/using-docker"},{"title":"Advanced Use","sidebarTitle":"Advanced Use","description":"Advanced features and configurations for power users, including settings files, HPSM, multi-threading, and obfuscation.","href":"/en/latest/cli/scanoss-py/advanced-use"}]},{"group":"SCANOSS-JS","expanded":false,"pages":[{"title":"Installation","sidebarTitle":"Installation","href":"/en/latest/cli/scanoss-js/installation"},{"title":"Scanning and Fingerprinting Examples","sidebarTitle":"Scanning and Fingerprinting Examples","description":"Practical CLI examples for scanning, dependency detection, cryptography detection, and fingerprint generation using scanoss-js.","href":"/en/latest/cli/scanoss-js/scanning-and-fingerprinting-examples"},{"title":"Commands \u0026 Arguments","sidebarTitle":"Commands \u0026 Arguments","href":"/en/latest/cli/scanoss-js/commands-and-arguments"}]},{"group":"Crypto Finder","expanded":false,"pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/en/latest/cli/crypto-finder/overview"},{"title":"Installation","sidebarTitle":"Installation","href":"/en/latest/cli/crypto-finder/installation"},{"title":"Quick start","sidebarTitle":"Quick start","href":"/en/latest/cli/crypto-finder/quick-start"},{"title":"Configuration","sidebarTitle":"Configuration","href":"/en/latest/cli/crypto-finder/configuration"},{"title":"Output formats","sidebarTitle":"Output formats","href":"/en/latest/cli/crypto-finder/output-formats"},{"title":"Docker usage","sidebarTitle":"Docker usage","href":"/en/latest/cli/crypto-finder/docker-usage"},{"title":"Dependency scanning and call chain attribution","sidebarTitle":"Dependency scanning and call chain attribution","href":"/en/latest/cli/crypto-finder/dependency-scanning"}]}]},{"group":"SDKs","expanded":false,"pages":[{"group":"Python SDK","expanded":false,"pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/en/latest/sdks/python/overview"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/en/latest/sdks/python/authentication"},{"title":"Usage","sidebarTitle":"Usage","href":"/en/latest/sdks/python/usage"}]},{"group":"Java SDK","expanded":false,"pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/en/latest/sdks/java/overview"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/en/latest/sdks/java/authentication"},{"title":"Usage","sidebarTitle":"Usage","href":"/en/latest/sdks/java/usage"}]},{"group":"JavaScript SDK","expanded":false,"pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/en/latest/sdks/javascript/overview"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/en/latest/sdks/javascript/authentication"},{"title":"Usage","sidebarTitle":"Usage","href":"/en/latest/sdks/javascript/usage"}]}]},{"group":"Clients / Tools","expanded":false,"pages":[{"group":"SBOM Workbench","expanded":false,"pages":[{"title":"Installation \u0026 Setup","sidebarTitle":"Installation \u0026 Setup","href":"/en/latest/clients/workbench/installation-quick-start"},{"title":"Scanning, Reporting and Auditing","sidebarTitle":"Scanning, Reporting and Auditing","href":"/en/latest/clients/workbench/project-scanning-auditing-reporting"},{"title":"Advanced Search \u0026 Final Review","sidebarTitle":"Advanced Search \u0026 Final Review","href":"/en/latest/clients/workbench/vulnerability-crypto-scanning"},{"title":"Exporting SBOMs and Projects","sidebarTitle":"Exporting SBOMs and Projects","href":"/en/latest/clients/workbench/metadata-export-import"}]},{"title":"SCANOSS-CC","sidebarTitle":"SCANOSS-CC","href":"/en/latest/clients/code-compare"}]},{"group":"APIs and Services","expanded":false,"pages":[{"title":"API Overview","sidebarTitle":"API Overview","href":"/en/latest/apis/api-overview"},{"title":"Cryptography API","sidebarTitle":"Cryptography API","href":"/en/latest/apis/encryption-api"},{"title":"Vulnerability API","sidebarTitle":"Vulnerability API","href":"/en/latest/apis/vulnerability-api"},{"title":"Component Search API","sidebarTitle":"Component Search API","href":"/en/latest/apis/component-search-api"},{"title":"License API","sidebarTitle":"License API","href":"/en/latest/apis/license-api"},{"title":"Geoprovenance API","sidebarTitle":"Geoprovenance API","href":"/en/latest/apis/geoprovenance-api"},{"title":"Dependencies API","sidebarTitle":"Dependencies API","href":"/en/latest/apis/dependencies-api"},{"title":"Scanning API","sidebarTitle":"Scanning API","href":"/en/latest/apis/scanning-api"},{"group":"Postman Setup","expanded":false,"pages":[{"title":"Workspace Setup","sidebarTitle":"Workspace Setup","href":"/en/latest/apis/postman/workspace-setup"},{"title":"Sending Requests and Reviewing Results","sidebarTitle":"Sending Requests and Reviewing Results","href":"/en/latest/apis/postman/sending-requests-reviewing-results"}]}]},{"group":"Advanced Topics","expanded":false,"pages":[{"title":"SBOM Formats","sidebarTitle":"SBOM Formats","href":"/en/latest/advanced/sbom-formats"},{"title":"Fast Winnowing \u0026 Fingerprinting","sidebarTitle":"Fast Winnowing \u0026 Fingerprinting","href":"/en/latest/advanced/fast-winnowing-fingerprint-algorithms"}]},{"group":"Release Notes \u0026 References","expanded":false,"pages":[{"title":"Changelog / Version History","sidebarTitle":"Changelog / Version History","href":"/en/latest/release-notes/changelog-version-history"},{"title":"References and External Docs","sidebarTitle":"References and External Docs","href":"/en/latest/release-notes/references-external-docs"}]},{"group":"Help \u0026 Support","expanded":false,"pages":[{"title":"Troubleshooting \u0026 FAQs","sidebarTitle":"Troubleshooting \u0026 FAQs","href":"/en/latest/troubleshooting-and-faqs"},{"title":"Support \u0026 Contribution","sidebarTitle":"Support \u0026 Contribution","href":"/en/latest/support-and-contribution"}]},{"group":"Links","public":true,"pages":[{"sidebarTitle":"SCANOSS Website","url":"https://www.scanoss.com/","title":null,"href":"/link/web"},{"sidebarTitle":"GitHub","url":"https://github.com/scanoss","title":null,"href":"/link/github"},{"sidebarTitle":"Youtube","url":"https://www.youtube.com/@SCANOSS","title":null,"href":"/link/youtube"}]}]},{"tab":"PoC","hidden":false,"pages":[{"title":"PoC","href":"/en/latest/poc/evaluation/introduction"}]}]}]},"basePath":"","title":"Installation - SCANOSS documentation","deploymentId":"dpl_7LpC8LvxVNTZSB7twCcVwH4TeFKv","buildId":"dpl_7LpC8LvxVNTZSB7twCcVwH4TeFKv","dynamics":["10e4515597"],"chunks":["BannerMarkdown-yrqkuj9T.js","dist-C5tMjMKm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}