[{"data":1,"prerenderedAt":594},["ShallowReactive",2],{"docs-page:\u002Fdocs\u002Finstallation":3,"docs-pages":248},{"id":4,"title":5,"body":6,"description":240,"extension":241,"meta":242,"navigation":243,"path":244,"seo":245,"stem":246,"__hash__":247},"docs\u002Fdocs\u002Finstallation.md","Installation",{"type":7,"value":8,"toc":233},"minimark",[9,13,17,22,39,42,80,86,95,102,111,115,118,126,129,133,161,165,168,188,204,208,211,226,229],[10,11,5],"h1",{"id":12},"installation",[14,15,16],"p",{},"The public installer downloads a prebuilt native SCPM binary. It does not build\nfrom source and does not require Cargo.",[18,19,21],"h2",{"id":20},"shell-installer","Shell Installer",[23,24,29],"pre",{"className":25,"code":26,"language":27,"meta":28,"style":28},"language-sh shiki shiki-themes github-light github-dark","curl -fsSL https:\u002F\u002Fscpm.dev\u002Finstall.sh | sh\n","sh","",[30,31,32],"code",{"__ignoreMap":28},[33,34,37],"span",{"class":35,"line":36},"line",1,[33,38,26],{},[14,40,41],{},"The script:",[43,44,45,49,52,59,65],"ul",{},[46,47,48],"li",{},"requires Node.js because SCPM manages Node projects;",[46,50,51],{},"detects operating system, CPU architecture, and Linux libc family;",[46,53,54,55,58],{},"downloads a compressed release binary from ",[30,56,57],{},"https:\u002F\u002Fscpm.dev\u002Freleases\u002F",";",[46,60,61,62,58],{},"verifies the archive with ",[30,63,64],{},"SHA256SUMS",[46,66,67,68,71,72,75,76,79],{},"installs ",[30,69,70],{},"scpm",", ",[30,73,74],{},"scpmr",", and ",[30,77,78],{},"scpmx",".",[14,81,82,83,79],{},"The default install directory is ",[30,84,85],{},"~\u002F.local\u002Fbin",[23,87,89],{"className":25,"code":88,"language":27,"meta":28,"style":28},"curl -fsSL https:\u002F\u002Fscpm.dev\u002Finstall.sh | SCPM_INSTALL_DIR=\"$HOME\u002Fbin\" sh\n",[30,90,91],{"__ignoreMap":28},[33,92,93],{"class":35,"line":36},[33,94,88],{},[14,96,97,98,101],{},"Make sure the install directory is on ",[30,99,100],{},"PATH",":",[23,103,105],{"className":25,"code":104,"language":27,"meta":28,"style":28},"export PATH=\"$HOME\u002F.local\u002Fbin:$PATH\"\n",[30,106,107],{"__ignoreMap":28},[33,108,109],{"class":35,"line":36},[33,110,104],{},[18,112,114],{"id":113},"published-assets","Published Assets",[14,116,117],{},"The installer looks for compressed binaries named like this:",[23,119,124],{"className":120,"code":122,"language":123,"meta":28},[121],"language-text","scpm-v1.17.1-linux-x64-gnu.gz\nscpm-v1.17.1-linux-arm64-gnu.gz\nscpm-v1.17.1-darwin-x64.gz\nscpm-v1.17.1-darwin-arm64.gz\n","text",[30,125,122],{"__ignoreMap":28},[14,127,128],{},"The current static release includes the Linux x64 GNU binary and a tarball for\nmanual inspection. Other platform binaries should be added to the same release\ndirectory before advertising those targets.",[18,130,132],{"id":131},"verify","Verify",[23,134,136],{"className":25,"code":135,"language":27,"meta":28,"style":28},"scpm --version\nscpm --help\nscpmr --help\nscpmx --help\n",[30,137,138,143,149,155],{"__ignoreMap":28},[33,139,140],{"class":35,"line":36},[33,141,142],{},"scpm --version\n",[33,144,146],{"class":35,"line":145},2,[33,147,148],{},"scpm --help\n",[33,150,152],{"class":35,"line":151},3,[33,153,154],{},"scpmr --help\n",[33,156,158],{"class":35,"line":157},4,[33,159,160],{},"scpmx --help\n",[18,162,164],{"id":163},"shortcut-binaries","Shortcut Binaries",[14,166,167],{},"The installer writes three commands:",[23,169,171],{"className":25,"code":170,"language":27,"meta":28,"style":28},"scpm   # main command\nscpmr  # shorthand for scpm run\nscpmx  # shorthand for scpm dlx\n",[30,172,173,178,183],{"__ignoreMap":28},[33,174,175],{"class":35,"line":36},[33,176,177],{},"scpm   # main command\n",[33,179,180],{"class":35,"line":145},[33,181,182],{},"scpmr  # shorthand for scpm run\n",[33,184,185],{"class":35,"line":151},[33,186,187],{},"scpmx  # shorthand for scpm dlx\n",[14,189,190,193,194,75,197,200,201,79],{},[30,191,192],{},"scpmr build"," is equivalent to ",[30,195,196],{},"scpm run build",[30,198,199],{},"scpmx cowsay hi"," is\nequivalent to ",[30,202,203],{},"scpm dlx cowsay hi",[18,205,207],{"id":206},"development-checkout","Development Checkout",[14,209,210],{},"Contributors who are changing the CLI can still build from a local checkout:",[23,212,214],{"className":25,"code":213,"language":27,"meta":28,"style":28},"cd cli\ncargo install --path crates\u002Fscpm --locked\n",[30,215,216,221],{"__ignoreMap":28},[33,217,218],{"class":35,"line":36},[33,219,220],{},"cd cli\n",[33,222,223],{"class":35,"line":145},[33,224,225],{},"cargo install --path crates\u002Fscpm --locked\n",[14,227,228],{},"That path is for SCPM development. The public installer uses prebuilt binaries.",[230,231,232],"style",{},"html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":28,"searchDepth":145,"depth":145,"links":234},[235,236,237,238,239],{"id":20,"depth":145,"text":21},{"id":113,"depth":145,"text":114},{"id":131,"depth":145,"text":132},{"id":163,"depth":145,"text":164},{"id":206,"depth":145,"text":207},"Install SCPM from the public binary installer and configure the install location.","md",{},true,"\u002Fdocs\u002Finstallation",{"title":5,"description":240},"docs\u002Finstallation","YhnAe5PxI7huhcvMCMBAI7ruvn1oYsXpOILpSET2BS8",[249,252,255,258,261,264,267,270,273,276,279,282,285,288,291,294,297,300,303,306,309,312,315,318,321,324,327,330,333,336,339,342,345,348,351,354,357,360,363,366,369,372,375,378,381,384,386,389,392,395,398,401,404,407,410,413,416,419,422,425,428,431,434,437,440,443,446,449,452,455,458,461,464,467,470,473,476,479,482,485,488,491,494,497,500,503,506,509,512,515,518,521,524,525,528,531,534,537,540,543,546,549,552,555,558,561,564,567,570,573,576,579,582,585,588,591],{"path":250,"title":251},"\u002Fdocs\u002Fbenchmarks","Benchmarks",{"path":253,"title":254},"\u002Fdocs\u002Fbun-users","For bun users",{"path":256,"title":257},"\u002Fdocs\u002Fcli\u002Fadd","scpm add",{"path":259,"title":260},"\u002Fdocs\u002Fcli\u002Fapprove-builds","scpm approve-builds",{"path":262,"title":263},"\u002Fdocs\u002Fcli\u002Faudit","scpm audit",{"path":265,"title":266},"\u002Fdocs\u002Fcli\u002Fbin","scpm bin",{"path":268,"title":269},"\u002Fdocs\u002Fcli\u002Fcache","scpm cache",{"path":271,"title":272},"\u002Fdocs\u002Fcli\u002Fcache\u002Fdelete","scpm cache delete",{"path":274,"title":275},"\u002Fdocs\u002Fcli\u002Fcache\u002Flist","scpm cache list",{"path":277,"title":278},"\u002Fdocs\u002Fcli\u002Fcache\u002Flist-registries","scpm cache list-registries",{"path":280,"title":281},"\u002Fdocs\u002Fcli\u002Fcache\u002Fprune","scpm cache prune",{"path":283,"title":284},"\u002Fdocs\u002Fcli\u002Fcache\u002Fview","scpm cache view",{"path":286,"title":287},"\u002Fdocs\u002Fcli\u002Fcat-file","scpm cat-file",{"path":289,"title":290},"\u002Fdocs\u002Fcli\u002Fcat-index","scpm cat-index",{"path":292,"title":293},"\u002Fdocs\u002Fcli\u002Fcheck","scpm check",{"path":295,"title":296},"\u002Fdocs\u002Fcli\u002Fci","scpm ci",{"path":298,"title":299},"\u002Fdocs\u002Fcli\u002Fclean","scpm clean",{"path":301,"title":302},"\u002Fdocs\u002Fcli\u002Fcompletion","scpm completion",{"path":304,"title":305},"\u002Fdocs\u002Fcli\u002Fconfig","scpm config",{"path":307,"title":308},"\u002Fdocs\u002Fcli\u002Fconfig\u002Fdelete","scpm config delete",{"path":310,"title":311},"\u002Fdocs\u002Fcli\u002Fconfig\u002Fexplain","scpm config explain",{"path":313,"title":314},"\u002Fdocs\u002Fcli\u002Fconfig\u002Ffind","scpm config find",{"path":316,"title":317},"\u002Fdocs\u002Fcli\u002Fconfig\u002Fget","scpm config get",{"path":319,"title":320},"\u002Fdocs\u002Fcli\u002Fconfig\u002Flist","scpm config list",{"path":322,"title":323},"\u002Fdocs\u002Fcli\u002Fconfig\u002Fset","scpm config set",{"path":325,"title":326},"\u002Fdocs\u002Fcli\u002Fconfig\u002Ftui","scpm config tui",{"path":328,"title":329},"\u002Fdocs\u002Fcli\u002Fcreate","scpm create",{"path":331,"title":332},"\u002Fdocs\u002Fcli\u002Fdedupe","scpm dedupe",{"path":334,"title":335},"\u002Fdocs\u002Fcli\u002Fdeploy","scpm deploy",{"path":337,"title":338},"\u002Fdocs\u002Fcli\u002Fdeprecate","scpm deprecate",{"path":340,"title":341},"\u002Fdocs\u002Fcli\u002Fdeprecations","scpm deprecations",{"path":343,"title":344},"\u002Fdocs\u002Fcli\u002Fdiag","scpm diag",{"path":346,"title":347},"\u002Fdocs\u002Fcli\u002Fdiag\u002Fanalyze","scpm diag analyze",{"path":349,"title":350},"\u002Fdocs\u002Fcli\u002Fdiag\u002Fcompare","scpm diag compare",{"path":352,"title":353},"\u002Fdocs\u002Fcli\u002Fdist-tag","scpm dist-tag",{"path":355,"title":356},"\u002Fdocs\u002Fcli\u002Fdist-tag\u002Fadd","scpm dist-tag add",{"path":358,"title":359},"\u002Fdocs\u002Fcli\u002Fdist-tag\u002Fls","scpm dist-tag ls",{"path":361,"title":362},"\u002Fdocs\u002Fcli\u002Fdist-tag\u002Frm","scpm dist-tag rm",{"path":364,"title":365},"\u002Fdocs\u002Fcli\u002Fdlx","scpm dlx",{"path":367,"title":368},"\u002Fdocs\u002Fcli\u002Fdoctor","scpm doctor",{"path":370,"title":371},"\u002Fdocs\u002Fcli\u002Fexec","scpm exec",{"path":373,"title":374},"\u002Fdocs\u002Fcli\u002Ffetch","scpm fetch",{"path":376,"title":377},"\u002Fdocs\u002Fcli\u002Ffind-hash","scpm find-hash",{"path":379,"title":380},"\u002Fdocs\u002Fcli\u002Fignored-builds","scpm ignored-builds",{"path":382,"title":383},"\u002Fdocs\u002Fcli\u002Fimport","scpm import",{"path":385,"title":70},"\u002Fdocs\u002Fcli",{"path":387,"title":388},"\u002Fdocs\u002Fcli\u002Finit","scpm init",{"path":390,"title":391},"\u002Fdocs\u002Fcli\u002Finstall","scpm install",{"path":393,"title":394},"\u002Fdocs\u002Fcli\u002Flicenses","scpm licenses",{"path":396,"title":397},"\u002Fdocs\u002Fcli\u002Flink","scpm link",{"path":399,"title":400},"\u002Fdocs\u002Fcli\u002Flist","scpm list",{"path":402,"title":403},"\u002Fdocs\u002Fcli\u002Flogin","scpm login",{"path":405,"title":406},"\u002Fdocs\u002Fcli\u002Flogout","scpm logout",{"path":408,"title":409},"\u002Fdocs\u002Fcli\u002Foutdated","scpm outdated",{"path":411,"title":412},"\u002Fdocs\u002Fcli\u002Fpack","scpm pack",{"path":414,"title":415},"\u002Fdocs\u002Fcli\u002Fpatch","scpm patch",{"path":417,"title":418},"\u002Fdocs\u002Fcli\u002Fpatch-commit","scpm patch-commit",{"path":420,"title":421},"\u002Fdocs\u002Fcli\u002Fpatch-remove","scpm patch-remove",{"path":423,"title":424},"\u002Fdocs\u002Fcli\u002Fpeers","scpm peers",{"path":426,"title":427},"\u002Fdocs\u002Fcli\u002Fpeers\u002Fcheck","scpm peers check",{"path":429,"title":430},"\u002Fdocs\u002Fcli\u002Fprune","scpm prune",{"path":432,"title":433},"\u002Fdocs\u002Fcli\u002Fpublish","scpm publish",{"path":435,"title":436},"\u002Fdocs\u002Fcli\u002Fpurge","scpm purge",{"path":438,"title":439},"\u002Fdocs\u002Fcli\u002Fquery","scpm query",{"path":441,"title":442},"\u002Fdocs\u002Fcli\u002Frebuild","scpm rebuild",{"path":444,"title":445},"\u002Fdocs\u002Fcli\u002Frecursive","scpm recursive",{"path":447,"title":448},"\u002Fdocs\u002Fcli\u002Fremove","scpm remove",{"path":450,"title":451},"\u002Fdocs\u002Fcli\u002Frestart","scpm restart",{"path":453,"title":454},"\u002Fdocs\u002Fcli\u002Froot","scpm root",{"path":456,"title":457},"\u002Fdocs\u002Fcli\u002Frun","scpm run",{"path":459,"title":460},"\u002Fdocs\u002Fcli\u002Fsbom","scpm sbom",{"path":462,"title":463},"\u002Fdocs\u002Fcli\u002Fsponsors","scpm sponsors",{"path":465,"title":466},"\u002Fdocs\u002Fcli\u002Fstage","scpm stage",{"path":468,"title":469},"\u002Fdocs\u002Fcli\u002Fstart","scpm start",{"path":471,"title":472},"\u002Fdocs\u002Fcli\u002Fstop","scpm stop",{"path":474,"title":475},"\u002Fdocs\u002Fcli\u002Fstore","scpm store",{"path":477,"title":478},"\u002Fdocs\u002Fcli\u002Fstore\u002Fadd","scpm store add",{"path":480,"title":481},"\u002Fdocs\u002Fcli\u002Fstore\u002Fpath","scpm store path",{"path":483,"title":484},"\u002Fdocs\u002Fcli\u002Fstore\u002Fprune","scpm store prune",{"path":486,"title":487},"\u002Fdocs\u002Fcli\u002Fstore\u002Fstatus","scpm store status",{"path":489,"title":490},"\u002Fdocs\u002Fcli\u002Ftest","scpm test",{"path":492,"title":493},"\u002Fdocs\u002Fcli\u002Fundeprecate","scpm undeprecate",{"path":495,"title":496},"\u002Fdocs\u002Fcli\u002Funlink","scpm unlink",{"path":498,"title":499},"\u002Fdocs\u002Fcli\u002Funpublish","scpm unpublish",{"path":501,"title":502},"\u002Fdocs\u002Fcli\u002Fupdate","scpm update",{"path":504,"title":505},"\u002Fdocs\u002Fcli\u002Fversion","scpm version",{"path":507,"title":508},"\u002Fdocs\u002Fcli\u002Fview","scpm view",{"path":510,"title":511},"\u002Fdocs\u002Fcli\u002Fwhy","scpm why",{"path":513,"title":514},"\u002Fdocs\u002Ferror-codes","Error and warning codes",{"path":516,"title":517},"\u002Fdocs\u002Fgetting-started","Getting Started",{"path":519,"title":520},"\u002Fdocs\u002Fguide","Guide",{"path":522,"title":523},"\u002Fdocs","SCPM Documentation",{"path":244,"title":5},{"path":526,"title":527},"\u002Fdocs\u002Fnpm-users","For npm users",{"path":529,"title":530},"\u002Fdocs\u002Fpackage-manager\u002Fconfiguration","Configuration",{"path":532,"title":533},"\u002Fdocs\u002Fpackage-manager\u002Fdependencies","Manage dependencies",{"path":535,"title":536},"\u002Fdocs\u002Fpackage-manager\u002Fglobal-virtual-store","Global virtual store",{"path":538,"title":539},"\u002Fdocs\u002Fpackage-manager\u002Finstall","Install dependencies",{"path":541,"title":542},"\u002Fdocs\u002Fpackage-manager\u002Fjailed-builds","Jailed dependency builds",{"path":544,"title":545},"\u002Fdocs\u002Fpackage-manager\u002Flifecycle-scripts","Lifecycle scripts",{"path":547,"title":548},"\u002Fdocs\u002Fpackage-manager\u002Flockfiles","Lockfiles",{"path":550,"title":551},"\u002Fdocs\u002Fpackage-manager\u002Fnode-modules","node_modules layout",{"path":553,"title":554},"\u002Fdocs\u002Fpackage-manager\u002Fpublishing","Publishing",{"path":556,"title":557},"\u002Fdocs\u002Fpackage-manager\u002Fregistry-auth","Registry and auth",{"path":559,"title":560},"\u002Fdocs\u002Fpackage-manager\u002Fscripts","Run scripts and binaries",{"path":562,"title":563},"\u002Fdocs\u002Fpackage-manager\u002Fsecurity-scanner","Security scanner",{"path":565,"title":566},"\u002Fdocs\u002Fpackage-manager\u002Fworkspaces","Workspaces",{"path":568,"title":569},"\u002Fdocs\u002Fpnpm-users","For pnpm users",{"path":571,"title":572},"\u002Fdocs\u002Fsecurity","Security",{"path":574,"title":575},"\u002Fdocs\u002Fsettings\u002Fcli","CLI Settings",{"path":577,"title":578},"\u002Fdocs\u002Fsettings\u002Fenv","Environment Settings",{"path":580,"title":581},"\u002Fdocs\u002Fsettings","Settings",{"path":583,"title":584},"\u002Fdocs\u002Fsettings\u002Fnpmrc",".npmrc Settings",{"path":586,"title":587},"\u002Fdocs\u002Fsettings\u002Fworkspace-yaml","Workspace YAML Settings",{"path":589,"title":590},"\u002Fdocs\u002Ftroubleshooting","Troubleshooting",{"path":592,"title":593},"\u002Fdocs\u002Fyarn-users","For yarn users",1780584396924]