1"use strict";(globalThis.webpackChunk_verdaccio_website=globalThis.webpackChunk_verdaccio_website||[]).push([[9114],{48331:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>r,contentTitle:()=>l,default:()=>h,frontMatter:()=>a,metadata:()=>n,toc:()=>c});const n=JSON.parse('{"id":"cli","title":"Command Line Tool","description":"The Verdaccio CLI is your tool to start and stop the application.","source":"@site/docs/cli.md","sourceDirName":".","slug":"/cli","permalink":"/docs/cli","draft":false,"unlisted":false,"editUrl":"https://github.com/verdaccio/website/edit/master/website/docs/cli.md","tags":[],"version":"current","lastUpdatedBy":"verdacciopack","lastUpdatedAt":1789720860000,"frontMatter":{"id":"cli","title":"Command Line Tool"},"sidebar":"docs","previous":{"title":"What is Verdaccio?","permalink":"/docs/what-is-verdaccio"},"next":{"title":"Using a private registry","permalink":"/docs/cli-registry"}}');var o=i(8265),s=i(92233);const a={id:"cli",title:"Command Line Tool"},l=void 0,r={},c=[{value:"Commands",id:"commands",level:2},{value:"Default config file location",id:"default-config-file-location",level:2},{value:"Config file format",id:"config-file-format",level:2},{value:"Default storage location",id:"default-storage-location",level:2},{value:"Default database file location",id:"default-database-file-location",level:2},{value:"Environment variables",id:"environment-variables",level:2}];function d(e){const t={a:"a",code:"code",h2:"h2",li:"li",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.p,{children:"The Verdaccio CLI is your tool to start and stop the application."}),"\n",(0,o.jsx)(t.h2,{id:"commands",children:"Commands"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-bash",children:"verdaccio --listen 4000 --config ~./config.yaml\n"})}),"\n",(0,o.jsxs)(t.table,{children:[(0,o.jsx)(t.thead,{children:(0,o.jsxs)(t.tr,{children:[(0,o.jsx)(t.th,{children:"Command"}),(0,o.jsx)(t.th,{children:"Default"}),(0,o.jsx)(t.th,{children:"Example"}),(0,o.jsx)(t.th,{children:"Description"})]})}),(0,o.jsxs)(t.tbody,{children:[(0,o.jsxs)(t.tr,{children:[(0,o.jsxs)(t.td,{children:["--listen \\ ",(0,o.jsx)(t.strong,{children:"-l"})]}),(0,o.jsx)(t.td,{children:"http:localhost:4873"}),(0,o.jsx)(t.td,{children:"7000"}),(0,o.jsxs)(t.td,{children:["Define protocol + host + port (",(0,o.jsx)(t.a,{href:"https://github.com/verdaccio/verdaccio/blob/08c36e688e8635733f92080eb3598239d43259cb/packages/node-api/src/cli-utils.ts#L7-L16",children:"formats"}),")"]})]}),(0,o.jsxs)(t.tr,{children:[(0,o.jsxs)(t.td,{children:["--config \\ ",(0,o.jsx)(t.strong,{children:"-c"})]}),(0,o.jsx)(t.td,{children:"~/.local/verdaccio/config.yaml"}),(0,o.jsx)(t.td,{children:"~./config.yaml"}),(0,o.jsx)(t.td,{children:"Set location of the configuration file"})]}),(0,o.jsxs)(t.tr,{children:[(0,o.jsxs)(t.td,{children:["--info \\ ",(0,o.jsx)(t.strong,{children:"-i"})]}),(0,o.jsx)(t.td,{}),(0,o.jsx)(t.td,{}),(0,o.jsx)(t.td,{children:"Print local environment information"})]}),(0,o.jsxs)(t.tr,{children:[(0,o.jsxs)(t.td,{children:["--version \\ ",(0,o.jsx)(t.strong,{children:"-v"})]}),(0,o.jsx)(t.td,{}),(0,o.jsx)(t.td,{}),(0,o.jsx)(t.td,{children:"Show version information"})]})]})]}),"\n",(0,o.jsx)(t.h2,{id:"default-config-file-location",children:"Default config file location"}),"\n",(0,o.jsxs)(t.p,{children:["To locate the home directory, verdaccio relies on ",(0,o.jsx)(t.strong,{children:"$XDG_DATA_HOME"})," as a first choice and for Windows environments we look for the ",(0,o.jsx)(t.a,{href:"https://www.howtogeek.com/318177/what-is-the-appdata-folder-in-windows/",children:"APPDATA environment variable"}),"."]}),"\n",(0,o.jsx)(t.h2,{id:"config-file-format",children:"Config file format"}),"\n",(0,o.jsx)(t.p,{children:"Config files should be YAML, JSON or a NodeJS module. YAML format is detected by parsing config file extension (yaml or yml, case insensitive)."}),"\n",(0,o.jsx)(t.h2,{id:"default-storage-location",children:"Default storage location"}),"\n",(0,o.jsxs)(t.p,{children:["We use the ",(0,o.jsx)(t.strong,{children:"$XDG_DATA_HOME"})," environment by variable default to locate the storage by default which ",(0,o.jsx)(t.a,{href:"https://askubuntu.com/questions/538526/is-home-local-share-the-default-value-for-xdg-data-home-in-ubuntu-14-04",children:"should be the same"})," as $HOME/.local/share.\nIf you are using a custom storage, this location is irrelevant."]}),"\n",(0,o.jsxs)(t.p,{children:["You can use ",(0,o.jsx)(t.code,{children:"VERDACCIO_STORAGE_PATH"})," to define an alternative storage path, read more about ",(0,o.jsx)(t.code,{children:"VERDACCIO_STORAGE_PATH"})," ",(0,o.jsx)(t.a,{href:"/docs/env#storage-path",children:"at the environment variables page"}),"."]}),"\n",(0,o.jsx)(t.h2,{id:"default-database-file-location",children:"Default database file location"}),"\n",(0,o.jsx)(t.p,{children:"The default database file location is within the storage location."}),"\n",(0,o.jsx)(t.h2,{id:"environment-variables",children:"Environment variables"}),"\n",(0,o.jsxs)(t.p,{children:[(0,o.jsx)(t.a,{href:"https://github.com/verdaccio/verdaccio/blob/master/docs/env.variables.md",children:"Full list of environment variables"}),"."]}),"\n",(0,o.jsxs)(t.ul,{children:["\n",(0,o.jsxs)(t.li,{children:[(0,o.jsx)(t.code,{children:"VERDACCIO_HANDLE_KILL_SIGNALS"})," to enable graceful shutdown. Only applies to ",(0,o.jsx)(t.code,{children:"6.x"}),": from ",(0,o.jsx)(t.code,{children:"7.x"})," graceful shutdown is always on and the variable was removed, see ",(0,o.jsx)(t.a,{href:"env",children:"environment variables"}),"."]}),"\n"]})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},92233:(e,t,i)=>{i.d(t,{R:()=>a,x:()=>l});var n=i(70141);const o={},s=n.createContext(o);function a(e){const t=n.useContext(s);return n.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),n.createElement(s.Provider,{value:t},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.