@zerops/zcli 1.0.23 → 1.0.24
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 +80 -0
- package/package.json +4 -2
package/README.md
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
<h2 align="center">
|
|
4
|
+
Zerops zCLI
|
|
5
|
+
<br/>
|
|
6
|
+
<br/>
|
|
7
|
+
</h2>
|
|
8
|
+
|
|
9
|
+
<p align="center">
|
|
10
|
+
<br/>
|
|
11
|
+
A <b>Command Line Utility / Command Line Interface</b> used for interacting with <a href="https://zerops.io/" target="_blank">Zerops</a> platform.
|
|
12
|
+
<br/>
|
|
13
|
+
</p>
|
|
14
|
+
|
|
15
|
+
<p align="center">
|
|
16
|
+
<b>Made with</b> ❤️ for <b>CI/CD</b> development and <b>CLI</b> lovers.
|
|
17
|
+
<br/>
|
|
18
|
+
</p>
|
|
19
|
+
|
|
20
|
+
<br />
|
|
21
|
+
|
|
22
|
+
<div align="center">
|
|
23
|
+
|
|
24
|
+
[](https://github.com/zeropsio/zcli/actions/workflows/ci.yml)
|
|
25
|
+
[](https://www.npmjs.com/package/@zerops/zcli)
|
|
26
|
+
[](https://badge.fury.io/js/@zerops%2Fzcli)
|
|
27
|
+
[](https://discord.gg/xxzmJSDKPT)
|
|
28
|
+
|
|
29
|
+
</div>
|
|
30
|
+
|
|
31
|
+
<br/>
|
|
32
|
+
|
|
33
|
+
<h3 align="end">
|
|
34
|
+
<a href="https://docs.zerops.io/" target="_blank">Read the docs →</a>
|
|
35
|
+
<br/>
|
|
36
|
+
</h3>
|
|
37
|
+
|
|
38
|
+
## Install
|
|
39
|
+
|
|
40
|
+
```sh
|
|
41
|
+
npm i -g @zerops/zcli
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Check out more installation ways at [zeropsio/zcli](https://github.com/zeropsio/zcli).
|
|
45
|
+
|
|
46
|
+
[!TIP]
|
|
47
|
+
> To download the zCLI directly, use the [latest release](https://github.com/zeropsio/zcli/releases/latest/) on GitHub.
|
|
48
|
+
|
|
49
|
+
## Requirements
|
|
50
|
+
|
|
51
|
+
- [Wireguard](https://www.wireguard.com/install/) - utilized by `zcli vpn` command.
|
|
52
|
+
|
|
53
|
+
## Quick Start
|
|
54
|
+
|
|
55
|
+
- Create a new personal access token from [settings/token-management](http://app.zerops.io/settings/token-management).
|
|
56
|
+
|
|
57
|
+
- Login to zCLI using the personal access token using the following command:
|
|
58
|
+
|
|
59
|
+
```Shell
|
|
60
|
+
zcli login <token>
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
- Push your project using the following command:
|
|
64
|
+
|
|
65
|
+
```Shell
|
|
66
|
+
zcli push
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Support
|
|
70
|
+
|
|
71
|
+
Having trouble? Get help in the official [Zerops Discord Server](https://discord.gg/xxzmJSDKPT).
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
## Additional Documentation
|
|
75
|
+
|
|
76
|
+
For more information go through [zCLI Documentation](https://docs.zerops.io/references/cli).
|
|
77
|
+
|
|
78
|
+
## Want to Contribute?
|
|
79
|
+
|
|
80
|
+
Contributions to zCLI are welcome and highly appreciated. However, We would like you to go through [CONTRIBUTING.md](https://github.com/zeropsio/zcli/blob/main/CONTRIBUTING.md).
|
package/package.json
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zerops/zcli",
|
|
3
|
-
"version": "v1.0.
|
|
3
|
+
"version": "v1.0.24",
|
|
4
|
+
"description": "The command-line interface used for interacting with Zerops Platform.",
|
|
4
5
|
"main": "./utils/binary.js",
|
|
5
6
|
"license": "MIT",
|
|
6
7
|
"private": false,
|
|
@@ -18,7 +19,8 @@
|
|
|
18
19
|
},
|
|
19
20
|
"files": [
|
|
20
21
|
"/utils",
|
|
21
|
-
"package.json"
|
|
22
|
+
"package.json",
|
|
23
|
+
"README.md"
|
|
22
24
|
],
|
|
23
25
|
"scripts": {
|
|
24
26
|
"postinstall": "node ./utils/install.js",
|