Skip to content

Commit

Permalink
Merge branch 'main' into new-readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nermalcat69 authored Aug 28, 2024
2 parents a1a7e2d + a75c8ad commit 31ca9b3
Show file tree
Hide file tree
Showing 9 changed files with 151 additions and 15 deletions.
1 change: 1 addition & 0 deletions .envrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
use flake
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
/.direnv/
/result
.idea
.sandbox
include/
Expand Down
48 changes: 36 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,10 @@

<div align="center">

[![CI](https://github.com/zeropsio/zcli/actions/workflows/main.yml/badge.svg)](https://github.com/zeropsio/zcli/actions/workflows/ci.yml)
[![NPM Downloads](https://img.shields.io/npm/d18m/%40zerops%2Fzcli)](https://www.npmjs.com/package/@zerops/zcli)
[![npm version](https://badge.fury.io/js/@zerops%2Fzcli.svg)](https://badge.fury.io/js/@zerops%2Fzcli)
[![Discord](https://img.shields.io/discord/735781031147208777)](https://discord.gg/xxzmJSDKPT)
[![npm bundle size](https://img.shields.io/bundlephobia/min/%40zerops%2Fzcli)](https://www.npmjs.com/package/@zerops/zcli)
[![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)
[![Discord](https://img.shields.io/discord/735781031147208777?labelColor=EDEFF3&color=8F9DA8)](https://discord.gg/xxzmJSDKPT)

</div>

Expand All @@ -36,17 +35,21 @@
<br/>
</h3>

## Supported platforms
### Supported platforms

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

## Requirements
### Optional requirements

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


<br/>


## Install zCLI

### Package managers
Expand Down Expand Up @@ -82,35 +85,56 @@ curl -L https://zerops.io/zcli/install.sh | sh

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, use the [latest release](https://github.com/zeropsio/zcli/releases/latest/) on GitHub.
> To download the zCLI directly, locate the binary for your OS in the [latest release](https://github.com/zeropsio/zcli/releases/latest/) on GitHub.

<br/>


## Quick Start

- Create a new personal access token from [settings/token-management](http://app.zerops.io/settings/token-management).
- 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 <token>
```

- Push your project using the following command:
- Run zcli to list commands and the current status

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


<br/>

## Community

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

25 changes: 25 additions & 0 deletions default.nix
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{ pkgs, self}:

pkgs.buildGoModule {
pname = "zcli";
version = "0..1";

src = self; #zcli;

nativeBuildInputs = with pkgs; [ go ];
vendorHash = null;

installPhase = ''
mkdir -p $out/bin
cp $GOPATH/bin/zcli $out/bin/
echo "Installed zcli to $out/bin/"
ls -l $out/bin
'';

meta = with pkgs.lib; {
description = "A command-line interface (CLI) tool built with Go";
homepage = "https://github.com/zeropsio/zcli";
license = licenses.mit;
maintainers = with maintainers; [ arbel-arad nermalcat69 ];
};
}
58 changes: 58 additions & 0 deletions flake.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 26 additions & 0 deletions flake.nix
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
description = "Zerops CLI utility";

inputs = {
nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
flake-parts.url = "github:hercules-ci/flake-parts";
};

outputs = { self, nixpkgs, ... }@inputs:
inputs.flake-parts.lib.mkFlake { inherit inputs; } {
flake = {
};
systems = [ "x86_64-linux" "aarch64-linux" "aarch64-darwin" "x86_64-darwin" ];
perSystem = { config, pkgs, system, ... }: {
packages.default = (import ./default.nix { inherit pkgs self; });
devShells.default = pkgs.mkShell {
nativeBuildInputs = with pkgs; [ go ];
shellHook = ''
go mod vendor
git add vendor/.
echo -e '\033[0;33mprepared vendor files\033[0m'
'';
};
};
};
}
1 change: 1 addition & 0 deletions src/archiveClient/handler_findFilesByRules_test.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
//go:build exclude
package archiveClient

import (
Expand Down
1 change: 1 addition & 0 deletions src/archiveClient/handler_findGitFiles_test.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
//go:build exclude
package archiveClient

import (
Expand Down
4 changes: 1 addition & 3 deletions tools/npm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@
[![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)
[![Discord](https://img.shields.io/discord/735781031147208777?labelColor=EDEFF3&color=8F9DA8)](https://discord.gg/xxzmJSDKPT)
[![npm bundle size](https://img.shields.io/bundlephobia/min/%40zerops%2Fzcli?labelColor=EDEFF3&color=8F9DA8)](https://www.npmjs.com/package/@zerops/zcli)


</div>

<br/>
Expand Down Expand Up @@ -79,4 +78,3 @@ For more information go through [zCLI Documentation](https://docs.zerops.io/refe
## 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).

0 comments on commit 31ca9b3

Please sign in to comment.