Installation • Command-line completion • Man documentation • Usage • CI Status • Contributing • License

siocrypt is a tool for encrypting/decrypting arbitrary data streams using Data At Rest Encryption (DARE).

Installation

From source

To build the siocrypt from scratch, make sure you have a working Go 1.24+ workspace (instructions), then:

go install github.com/essentialkaos/siocrypt@latest

Container Image

The latest version of siocrypt also available as container image on GitHub Container Registry and Docker Hub:

podman run --rm -it ghcr.io/essentialkaos/siocrypt:latest
# or
docker run --rm -it ghcr.io/essentialkaos/siocrypt:latest

Prebuilt binaries

You can download prebuilt binaries for Linux and macOS from EK Apps Repository:

bash <(curl -fsSL https://apps.kaos.st/get) siocrypt

Upgrading

You can update prebuilt siocrypt binary to the latest release using self-update feature:

siocrypt --update

This command will runs a self-update in interactive mode. If you want to run a quiet update (no output), use the following command:

siocrypt --update=quiet

Command-line completion

You can generate completion for bash, zsh or fish shell.

Bash:

siocrypt --completion=bash | sudo tee /etc/bash_completion.d/siocrypt > /dev/null

ZSH:

siocrypt --completion=zsh | sudo tee /usr/share/zsh/site-functions/siocrypt > /dev/null

Fish:

siocrypt --completion=fish | sudo tee /usr/share/fish/vendor_completions.d/siocrypt.fish > /dev/null

Man documentation

You can generate man page using next command:

siocrypt --generate-man | sudo gzip > /usr/share/man/man1/siocrypt.1.gz

Usage

CI Status

Branch	Status
master
develop

Contributing

Before contributing to this project please read our Contributing Guidelines.

License

Apache License, Version 2.0