Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sgaunet/gocrypt

gocrypt is a command line tool to encrypt/decrypt file in AES128/256/512.
https://github.com/sgaunet/gocrypt

aes cli crypt

Last synced: 14 days ago
JSON representation

gocrypt is a command line tool to encrypt/decrypt file in AES128/256/512.

Host: GitHub
URL: https://github.com/sgaunet/gocrypt
Owner: sgaunet
License: mit
Created: 2022-04-01T07:34:16.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-07-28T19:17:31.000Z (5 months ago)
Last Synced: 2024-07-28T20:28:41.415Z (5 months ago)
Topics: aes, cli, crypt
Language: Go
Homepage:
Size: 130 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Go Report Card](https://goreportcard.com/badge/github.com/sgaunet/gocrypt)](https://goreportcard.com/report/github.com/sgaunet/gocrypt)

[![GitHub release](https://img.shields.io/github/release/sgaunet/gocrypt.svg)](https://github.com/sgaunet/gocrypt/releases/latest)

![GitHub Downloads](https://img.shields.io/github/downloads/sgaunet/gocrypt/total)

[![Maintainability](https://api.codeclimate.com/v1/badges/7a634c0c2e4e4126e1b7/maintainability)](https://codeclimate.com/github/sgaunet/gocrypt/maintainability)

[![GoDoc](https://godoc.org/github.com/sgaunet/gocrypt?status.svg)](https://godoc.org/github.com/sgaunet/gocrypt)

[![License](https://img.shields.io/github/license/sgaunet/gocrypt.svg)](LICENSE)

# Gocrypt

gocrypt is a command line tool to encrypt/decrypt file in AES128/256/512.

Usage is quite simple :

```

$ gocrypt help

Tool to encrypt/decrypt file in AES128/256/512.

Usage:

  gocrypt [command]

Available Commands:

  completion  Generate the autocompletion script for the specified shell

  dec         decrypt file in AES 128/256/512

  enc         encrypt file in AES 128/256/512

  help        Help about any command

  version     print version of gocrypt

Flags:

  -h, --help   help for gocrypt

Use "gocrypt [command] --help" for more information about a command.

```

Here is a little demo:

![Demo](doc/demo.gif)

# Install

Download the binary in the release section. There is no docker image, but you can install a binary in your Docker image if needed. If you want to create a docker image from scratch, you will need to do a multi stage docker build in order to download the binary.

## With homebrew

```

brew install sgaunet/tools/gocrypt

```

## Use it in your own Docker image

```

FROM sgaunet/gocrypt:latest as gocrypt

FROM alpine:latest

COPY --from=gocrypt /gocrypt /usr/local/bin/gocrypt

...

```

# Tests

Tests are done with [venom](https://github.com/ovh/venom).

```

cd tests

venom run

```

# Development

This project is using :

* golang

* [task for development](https://taskfile.dev/#/)

* docker

* [docker buildx](https://github.com/docker/buildx)

* docker manifest

* [goreleaser](https://goreleaser.com/)

* [venom](https://github.com/ovh/venom) : Tests

* [pre-commit](https://pre-commit.com/)

There are hooks executed in the precommit stage. Once the project cloned on your disk, please install pre-commit:

```

brew install pre-commit

```

Install tools:

```

task dev:install-prereq

```

And install the hooks:

```

task dev:install-pre-commit

```

If you like to launch manually the pre-commmit hook:

```

task dev:pre-commit

```