2021-07-11 08:42:56 -05:00
---
id: cli
2022-12-25 12:48:18 -05:00
title: 'Command Line Tool'
2021-07-11 08:42:56 -05:00
---
The Verdaccio CLI is your tool to start and stop the application.
2021-07-27 14:52:49 -05:00
## Commands {#commands}
2021-07-11 08:42:56 -05:00
```bash
verdaccio --listen 4000 --config ~./config.yaml
```
2022-12-25 12:48:18 -05:00
| Command | Default | Example | Description |
| ------------------ | ------------------------------ | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| --listen \ **-l** | http:localhost:4873 | 7000 | Define protocol + host + port ([formats](https://github.com/verdaccio/verdaccio/blob/08c36e688e8635733f92080eb3598239d43259cb/packages/node-api/src/cli-utils.ts#L7-L16)) |
| --config \ **-c** | ~/.local/verdaccio/config.yaml | ~./config.yaml | Set location of the configuration file |
| --info \ **-i** | | | Print local environment information |
| --version \ **-v** | | | Show version information |
2021-07-11 08:42:56 -05:00
2021-07-27 14:52:49 -05:00
## Default config file location {#default-config-file-location}
2021-07-11 08:42:56 -05:00
2023-02-09 14:48:01 -05:00
To locate the home directory, verdaccio relies on ** $XDG_DATA_HOME** as a first choice and for Windows environments we look for the [APPDATA environment variable ](https://www.howtogeek.com/318177/what-is-the-appdata-folder-in-windows/ ).
2021-07-11 08:42:56 -05:00
2021-07-27 14:52:49 -05:00
## Config file format {#config-file-format}
2021-07-11 08:42:56 -05:00
Config files should be YAML, JSON or a NodeJS module. YAML format is detected by parsing config file extension (yaml or yml, case insensitive).
2021-07-27 14:52:49 -05:00
## Default storage location {#default-storage-location}
2021-07-11 08:42:56 -05:00
We use the ** $XDG_DATA_HOME** environment by variable 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.
2021-07-27 14:52:49 -05:00
## Default database file location {#default-database-file-location}
2021-07-11 08:42:56 -05:00
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**.
2021-07-27 14:52:49 -05:00
## Environment variables {#environment-variables}
2021-07-11 08:42:56 -05:00
[Full list of environment variables ](https://github.com/verdaccio/verdaccio/blob/master/docs/env.variables.md ).
2022-12-25 12:48:18 -05:00
- `VERDACCIO_HANDLE_KILL_SIGNALS` to enable gracefully shutdown (since v4.12.0)