1"use strict";(self.webpackChunk=self.webpackChunk||[]).push([["13653"],{51632(e,n,s){s.r(n),s.d(n,{metadata:()=>r,default:()=>p,frontMatter:()=>l,contentTitle:()=>o,toc:()=>d,assets:()=>c});var r=JSON.parse('{"id":"cli/server","title":"pnpm server","description":"Deprecated feature","source":"@site/versioned_docs/version-10.x/cli/server.md","sourceDirName":"cli","slug":"/cli/server","permalink":"/10.x/cli/server","draft":false,"unlisted":false,"editUrl":"https://github.com/pnpm/pnpm.io/edit/main/versioned_docs/version-10.x/cli/server.md","tags":[],"version":"10.x","lastUpdatedBy":"Zoltan Kochan","lastUpdatedAt":1771892155000,"frontMatter":{"id":"server","title":"pnpm server"},"sidebar":"docs","previous":{"title":"pnpm -r, --recursive","permalink":"/10.x/cli/recursive"},"next":{"title":"pnpm store","permalink":"/10.x/cli/store"}}'),t=s(91987),i=s(67008);let l={id:"server",title:"pnpm server"},o,c={},d=[{value:"Commands",id:"commands",level:2},{value:"pnpm server start",id:"pnpm-server-start",level:3},{value:"pnpm server stop",id:"pnpm-server-stop",level:3},{value:"pnpm server status",id:"pnpm-server-status",level:3},{value:"Options",id:"options",level:2},{value:"--background",id:"--background",level:3},{value:"--network-concurrency",id:"--network-concurrency",level:3},{value:"--protocol",id:"--protocol",level:3},{value:"--port",id:"--port",level:3},{value:"--store-dir",id:"--store-dir",level:3},{value:"--[no-]lock",id:"--no-lock",level:3},{value:"--ignore-stop-requests",id:"--ignore-stop-requests",level:3},{value:"--ignore-upload-requests",id:"--ignore-upload-requests",level:3}];function a(e){let n={admonition:"admonition",code:"code",h2:"h2",h3:"h3",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.admonition,{type:"danger",children:(0,t.jsx)(n.p,{children:"Deprecated feature"})}),"\n",(0,t.jsx)(n.p,{children:"Manage a store server."}),"\n",(0,t.jsx)(n.h2,{id:"commands",children:"Commands"}),"\n",(0,t.jsx)(n.h3,{id:"pnpm-server-start",children:"pnpm server start"}),"\n",(0,t.jsx)(n.p,{children:"Starts a server that performs all interactions with the store.\nOther commands will delegate any store-related tasks to this server."}),"\n",(0,t.jsx)(n.h3,{id:"pnpm-server-stop",children:"pnpm server stop"}),"\n",(0,t.jsx)(n.p,{children:"Stops the store server."}),"\n",(0,t.jsx)(n.h3,{id:"pnpm-server-status",children:"pnpm server status"}),"\n",(0,t.jsx)(n.p,{children:"Prints information about the running server."}),"\n",(0,t.jsx)(n.h2,{id:"options",children:"Options"}),"\n",(0,t.jsx)(n.h3,{id:"--background",children:"--background"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Default: ",(0,t.jsx)(n.strong,{children:"false"})]}),"\n",(0,t.jsxs)(n.li,{children:["Type: ",(0,t.jsx)(n.strong,{children:"Boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Runs the server in the background, similar to daemonizing on UNIX systems."}),"\n",(0,t.jsx)(n.h3,{id:"--network-concurrency",children:"--network-concurrency"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Default: ",(0,t.jsx)(n.strong,{children:"null"})]}),"\n",(0,t.jsxs)(n.li,{children:["Type: ",(0,t.jsx)(n.strong,{children:"Number"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The maximum number of network requests to process simultaneously."}),"\n",(0,t.jsx)(n.h3,{id:"--protocol",children:"--protocol"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Default: ",(0,t.jsx)(n.strong,{children:"auto"})]}),"\n",(0,t.jsxs)(n.li,{children:["Type: ",(0,t.jsx)(n.strong,{children:"auto"}),", ",(0,t.jsx)(n.strong,{children:"tcp"}),", ",(0,t.jsx)(n.strong,{children:"ipc"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["The communication protocol used by the server.\nWhen this is set to ",(0,t.jsx)(n.code,{children:"auto"}),", IPC is used on all systems except for Windows,\nwhich uses TCP."]}),"\n",(0,t.jsx)(n.h3,{id:"--port",children:"--port"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Default: ",(0,t.jsx)(n.strong,{children:"5813"})]}),"\n",(0,t.jsxs)(n.li,{children:["Type: ",(0,t.jsx)(n.strong,{children:"port number"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["The port number to use when TCP is used for c
1ommunication.\nIf a port is specified and the protocol is set to ",(0,t.jsx)(n.code,{children:"auto"}),", regardless of system\ntype, the protocol is automatically set to use TCP."]}),"\n",(0,t.jsx)(n.h3,{id:"--store-dir",children:"--store-dir"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Default: ",(0,t.jsx)(n.strong,{children:"<home>/.pnpm-store"})]}),"\n",(0,t.jsxs)(n.li,{children:["Type: ",(0,t.jsx)(n.strong,{children:"Path"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"The directory to use for the content addressable store."}),"\n",(0,t.jsx)(n.h3,{id:"--no-lock",children:"--[no-]lock"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Default: ",(0,t.jsx)(n.strong,{children:"false"})]}),"\n",(0,t.jsxs)(n.li,{children:["Type: ",(0,t.jsx)(n.strong,{children:"Boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Set whether to make the package store immutable to external processes while\nthe server is running or not."}),"\n",(0,t.jsx)(n.h3,{id:"--ignore-stop-requests",children:"--ignore-stop-requests"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Default: ",(0,t.jsx)(n.strong,{children:"false"})]}),"\n",(0,t.jsxs)(n.li,{children:["Type: ",(0,t.jsx)(n.strong,{children:"Boolean"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Prevents you from stopping the server using ",(0,t.jsx)(n.code,{children:"pnpm server stop"}),"."]}),"\n",(0,t.jsx)(n.h3,{id:"--ignore-upload-requests",children:"--ignore-upload-requests"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Default: ",(0,t.jsx)(n.strong,{children:"false"})]}),"\n",(0,t.jsxs)(n.li,{children:["Type: ",(0,t.jsx)(n.strong,{children:"Boolean"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Prevents creating a new side effect cache during install."})]})}function p(e={}){let{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},67008(e,n,s){s.d(n,{R:()=>l,x:()=>o});var r=s(71763);let t={},i=r.createContext(t);function l(e){let n=r.useContext(i);return r.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.