https://github.com/zeropsio/zcli

Zerops command line utility
https://github.com/zeropsio/zcli

cli devops golang hacktoberfest

Last synced: 9 days ago
JSON representation

Zerops command line utility

• Host: GitHub
• URL: https://github.com/zeropsio/zcli
• Owner: zeropsio
• License: mit
• Created: 2020-06-05T06:33:59.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2025-04-10T18:40:03.000Z (10 months ago)
• Last Synced: 2025-04-14T18:12:13.516Z (10 months ago)
• Topics: cli, devops, golang, hacktoberfest
• Language: Go
• Homepage:
• Size: 1.31 MB
• Stars: 30
• Watchers: 5
• Forks: 10
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![Zerops](https://github.com/zeropsio/recipe-shared-assets/blob/main/covers/svg/cover-zcli.svg)



   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](https://img.shields.io/github/actions/workflow/status/zeropsio/zcli/main.yml?labelColor=EDEFF3&color=8F9DA8)](https://github.com/zeropsio/zcli/actions/workflows/ci.yml)

[![NPM Downloads](https://img.shields.io/npm/d18m/%40zerops%2Fzcli?labelColor=EDEFF3&color=8F9DA8)](https://www.npmjs.com/package/@zerops/zcli)

[![npm version](https://img.shields.io/badge/dynamic/json?color=8F9DA8&labelColor=EDEFF3&label=@zerops/zcli&query=version&url=https%3A%2F%2Fbadge.fury.io%2Fjs%2F@zerops%252Fzcli.json)](https://badge.fury.io/js/@zerops%2Fzcli)

[![CPU](https://img.shields.io/badge/CPU-x86%2C%20x64%2C%20ARM%2C%20ARM64-8F9DA8?labelColor=EDEFF3)](https://docs.abblix.com/docs/technical-requirements)

[![Discord](https://img.shields.io/discord/735781031147208777?labelColor=EDEFF3&color=8F9DA8)](https://discord.gg/xxzmJSDKPT)








Read the docs →






### Supported platforms

- Windows

- Linux

- MacOS (arm64, amd64)

- NixOS

### Optional requirements

- [Wireguard](https://www.wireguard.com/install/) - utilized by `zcli vpn` command.

- ping - utilized by `zcli vpn` command.




## Install zCLI

### Package managers

#### Npm

```sh

npm i -g @zerops/zcli

```

### Windows

Execute following command in PowerShell:

```powershell

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

```

### Linux/MacOS

Execute following command in Terminal:

```shell

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).







> [!TIP]

> To download the zCLI directly, locate the binary for your OS in the [latest release](https://github.com/zeropsio/zcli/releases/latest/) on GitHub.




## Quick Start

- Create a new personal access token at [settings/token-management](http://app.zerops.io/settings/token-management) in Zerops GUI.

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

```Shell

zcli login 

```

- Run zcli to list commands and the current status

```Shell

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](https://github.com/zeropsio/zcli/blob/main/CONTRIBUTING.md).




## Community

To chat with other community members, you can join the [Zerops Discord Server](https://discord.gg/xxzmJSDKPT).