abcrypt

abcrypt (abcrypt-cli) is a command-line utility for encrypt and decrypt files using the abcrypt format.

Installation

From source

cargo install abcrypt-cli

If you want to enable optimizations such as LTO, set them using environment variables.

From binaries

The release page contains pre-built binaries for Linux, macOS and Windows.

How to build

Please see BUILD.adoc.

Usage

Basic usage

Encrypt a file:

abcrypt encrypt data.txt > data.txt.abcrypt

Decrypt a file:

abcrypt decrypt data.txt.abcrypt > data.txt

Provides information about the encryption parameters

Output as a human-readable string:

abcrypt information data.txt.abcrypt

Output:

Parameters used: memoryCost = 32; timeCost = 3; parallelism = 4;

Output as JSON:

abcrypt information -j data.txt.abcrypt | jq

Output:

{
  "memoryCost": 32,
  "timeCost": 3,
  "parallelism": 4
}

Generate shell completion

--generate-completion option generates shell completions to stdout.

The following shells are supported:

• bash
• elvish
• fish
• nushell
• powershell
• zsh

Example:

abcrypt --generate-completion bash > abcrypt.bash

Command-line options

Please see the following:

• abcrypt(1)
• abcrypt-encrypt(1)
• abcrypt-decrypt(1)
• abcrypt-information(1)
• abcrypt-help(1)

Changelog

Please see CHANGELOG.adoc.

Contributing

Please see CONTRIBUTING.adoc.

License

Copyright © 2022–2024 Shun Sakai (see AUTHORS.adoc)

1. This program is distributed under the terms of the GNU General Public License v3.0 or later.
2. Some files are distributed under the terms of the Creative Commons Attribution 4.0 International Public License.

This project is compliant with version 3.0 of the REUSE Specification. See copyright notices of individual files for more details on copyright and licensing information.