Skip to content

Latest commit

 

History

History
142 lines (83 loc) · 3.25 KB

README.md

File metadata and controls

142 lines (83 loc) · 3.25 KB
Raw

Zerops

Zerops zCLI


A Command Line Utility / Command Line Interface used for interacting with Zerops platform.

Made with ❤️ for CI/CD development and CLI lovers.


CI NPM Downloads npm version CPU Discord


Read the docs →

Supported platforms

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

Optional requirements

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

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 / execuetable of zCli.
  • zCLI's binary / execuetable 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).



Tip

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


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

Additional Documentation

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


Want to Contribute?

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


Community

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