0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-12-23 22:27:34 -05:00
verdaccio/docs/cli.md

32 lines
1.3 KiB
Markdown
Raw Normal View History

---
id: cli
title: "Command Line Tool"
---
2017-07-04 00:20:13 -05:00
The verdaccio CLI is your go start the application.
2017-07-04 00:20:13 -05:00
## Commands
```bash
verdaccio --listen 4000 --config ~./config.yaml
2017-07-04 00:20:13 -05:00
```
Command | Default | Example | Description
--- | --- | --- | ---
2017-07-04 00:20:13 -05:00
--listen \ **-l** | 4873 | -p 7000 | http port
--config \ **-c** | ~/.local/verdaccio/config.yaml | ~./config.yaml | the configuration file
## Default config file location
To locate the home directory, we rely on **$XDG_DATA_HOME** as a first choice and Windows environment we look for [APPDATA environment variable](https://www.howtogeek.com/318177/what-is-the-appdata-folder-in-windows/).
## Default storage location
We use **$XDG_DATA_HOME** environment variable as default to locate the storage by default which [should be the same](https://askubuntu.com/questions/538526/is-home-local-share-the-default-value-for-xdg-data-home-in-ubuntu-14-04) as $HOME/.local/share.
If you are using a custom storage, this location is irrelevant.
2018-08-26 06:47:51 -05:00
## Default database file location
The default database file location is in the storage location.
Starting with version 4.0.0, the database file name will be **.verdaccio-db.json** for a new installation of Verdaccio.
When upgrading an existing Verdaccio server, the file name will remain **.sinopia-db.json**.