Zcli

<h2 align="center"> Zerops zCLI <br/> <br/> </h2> <p align="center"> <br/> A <b>Command Line Utility / Command Line Interface</b> used for interacting with <a href="https://zerops.io/" target="_blank">Zerops</a> platform. <br/> </p> <p align="center"> <b>Made with</b> ❤️ for <b>CI/CD</b> development and <b>CLI</b> lovers. <br/> </p> <br /> <div align="center">

</div> <br/> <h3 align="end"> <a href="https://docs.zerops.io/" target="_blank">Read the docs →</a> <br/> </h3>

Supported platforms

• Windows
• Linux
• MacOS (arm64, amd64)
• NixOS

Optional requirements

• Wireguard - utilized by zcli vpn command.
• ping - utilized by zcli vpn command.

<br/>

Install zCLI

Package managers

Npm

npm i -g @zerops/zcli

Windows

Execute following command in PowerShell:

irm https://zerops.io/zcli/install.ps1 | iex

Linux/MacOS

Execute following command in Terminal:

curl -L https://zerops.io/zcli/install.sh | sh

NixOS

• Clone this repository
• cd zcli into the root of the cloned repository and run nix develop.
• Run nix build to build the binary / executable of zCLI.
• zCLI's binary / executable will be present in ./result/bin/zcli.

Currently, the zCLI is distributed for Linux (x86 & x64 architecture), macOS (x64 & M1 architecture) and Windows (x64 architecture).

<br/> <br/>

[!TIP] To download the zCLI directly, locate the binary for your OS in the latest release on GitHub.

<br/>

Quick Start

• Create a new personal access token at settings/token-management in Zerops GUI.

• Login to zCLI using the personal access token using the following command:

zcli login <token>

• Run zcli to list commands and the current status

zcli

<br/>

Additional Documentation

For more information go through https://docs.zerops.io/references/cli.

<br/>

Want to Contribute?

Contributions to zCLI are welcome and highly appreciated. However, We would like you to go through CONTRIBUTING.md.

<br/>

Community

To chat with other community members, you can join the Zerops Discord Server.