0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-12-16 21:56:25 -05:00

(doc): Upload cli documentation

This commit is contained in:
Juan Picado @jotadeveloper 2017-07-04 07:20:13 +02:00
parent c54f886525
commit 432a6c4eaf
No known key found for this signature in database
GPG key ID: 18AC54485952D158
2 changed files with 31 additions and 1 deletions

View file

@ -9,9 +9,9 @@ from a fresh look at the code and the outstanding issues. So here we are 🎉
## Getting Started
<!---
* [Command Line](cli.md)
* [Understand the configuration file](config.md)
-->
* [Command Line](cli.md)
* [Setting up *uplinks*](uplinks.md)
* [Packages Access](packages.md)
<!---

30
wiki/cli.md Normal file
View file

@ -0,0 +1,30 @@
# Command Line Interface
The verdaccio CLI is your go start the application.
## Installation
Please make sure latest Node 4 LTS and NPM 3+ are installed.
Then, install the CLI globally (you may need sudo):
```bash
$ npm install -g verdaccio
```
or if you use `yarn`
```bash
$ yarn add global verdaccio
```
## Commands
```bash
$ verdaccio --listen 4000 --config ./config.yaml
```
Command | Default | Example | Description
--- | --- | --- | ---
--listen \ **-l** | 4873 | -p 7000 | http port
--config \ **-c** | ~/home/user/.local/verdaccio/config.yaml | /foo/bar/config.yaml | the configuration file