mirror of
https://github.com/verdaccio/verdaccio.git
synced 2025-01-06 22:40:26 -05:00
(doc): Upload cli documentation
This commit is contained in:
parent
c54f886525
commit
432a6c4eaf
2 changed files with 31 additions and 1 deletions
|
@ -9,9 +9,9 @@ from a fresh look at the code and the outstanding issues. So here we are 🎉
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
<!---
|
<!---
|
||||||
* [Command Line](cli.md)
|
|
||||||
* [Understand the configuration file](config.md)
|
* [Understand the configuration file](config.md)
|
||||||
-->
|
-->
|
||||||
|
* [Command Line](cli.md)
|
||||||
* [Setting up *uplinks*](uplinks.md)
|
* [Setting up *uplinks*](uplinks.md)
|
||||||
* [Packages Access](packages.md)
|
* [Packages Access](packages.md)
|
||||||
<!---
|
<!---
|
||||||
|
|
30
wiki/cli.md
Normal file
30
wiki/cli.md
Normal 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
|
Loading…
Reference in a new issue