nivii 0.2.2 → 0.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Nivii CLI
|
|
2
|
+
|
|
3
|
+
> ⚡ The fastest, most beautiful way to share any local dev project.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm i -g nivii
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
# Share your project instantly
|
|
15
|
+
nivii share
|
|
16
|
+
|
|
17
|
+
# Share with custom slug (Pro)
|
|
18
|
+
nivii share --slug my-demo
|
|
19
|
+
|
|
20
|
+
# Password protect
|
|
21
|
+
nivii share --pass secret123
|
|
22
|
+
|
|
23
|
+
# Live sync mode
|
|
24
|
+
nivii share --live
|
|
25
|
+
|
|
26
|
+
# List deployments
|
|
27
|
+
nivii ls
|
|
28
|
+
|
|
29
|
+
# View analytics
|
|
30
|
+
nivii analytics
|
|
31
|
+
|
|
32
|
+
# Config
|
|
33
|
+
nivii config
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Flags
|
|
37
|
+
|
|
38
|
+
| Flag | Description |
|
|
39
|
+
|------|-------------|
|
|
40
|
+
| `--dir <dir>` | Directory to deploy |
|
|
41
|
+
| `--slug <slug>` | Custom slug (Pro) |
|
|
42
|
+
| `--pass <password>` | Password protection |
|
|
43
|
+
| `--otp` | One-time password |
|
|
44
|
+
| `--expires <duration>` | 1h / 24h / 7d / 30d / never |
|
|
45
|
+
| `--live` | Live sync mode |
|
|
46
|
+
| `--collab` | Collaborative preview (Pro) |
|
|
47
|
+
| `--no-build` | Skip build step |
|
|
48
|
+
| `--cmd <cmd>` | Custom build command |
|
|
49
|
+
| `--max-views <n>` | Self-destruct after N views |
|
|
50
|
+
| `--self-destruct` | Destroy after first view |
|
|
51
|
+
| `--no-qr` | Skip QR code |
|
|
52
|
+
| `--no-open` | Don't auto-open browser |
|
|
53
|
+
|
|
54
|
+
## License
|
|
55
|
+
|
|
56
|
+
AGPL-3.0
|