Installation

Pre-built binaries

You can download Kryptor for Windows, Linux, and macOS here.

Please follow the project on GitHub and regularly use the -u|--update option to check for updates. It is important to stay up-to-date for security and compatibility reasons.

Kryptor runs offline and does not perform automatic checks for updates.

Verifying signatures

The Minisign signatures (.minisign) can be found in the Download Kryptor section and in each GitHub release. Download the signature for your version and make sure it is in the same directory as the downloaded Kryptor ZIP file.

Downloaded files can be verified with Minisign using the following command, replacing [file] with the file path of the Kryptor ZIP file:

$ minisign -Vm [file] -P RWRZzvSG5htEUFlSEl88cMb0pTGXSZmzqTujwpAweUrSJQuWYui8Qpk9

Minisign should display the message Signature and comment signature verified, followed by the trusted comment Kryptor v[version].

If you see another message, then your download is either corrupted or not legitimate and may be unsafe.​

Running Kryptor on Windows

  1. Navigate to the location of the downloaded ZIP file (e.g. the Downloads folder).

  2. Right click the kryptor-windows.zip file and select Extract All.

  3. Open up the Command Prompt (e.g. search for cmd in the taskbar) and navigate to the path of the extracted folder (e.g. cd C:\Users\USERNAME\Downloads\kryptor-windows).

  4. Type kryptor --help for a list of commands and some examples.

When referencing file paths/file names that contain spaces, you must surround them with "speech marks" like so:​

$ kryptor -e -p "GitHub Logo.png"
$ kryptor -e -p "C:\Users\samuel-lucas6\Downloads\GitHub Logo.png"

I recommend moving the kryptor.exe and vcruntime140.dll files into C:\Users\USERNAME for easier access from the Command Prompt.

You must keep the vcruntime140.dll file in the same folder as kryptor.exe. Do not move thekryptor.exefile into a directory that requires administrator privileges.

Running Kryptor on Linux & macOS

  1. Open up the terminal and navigate to the path of the downloaded ZIP file (e.g. cd Downloads).

  2. Type unzip kryptor-linux.zip or unzip kryptor-macos.zipdepending on your version.

  3. Navigate to the extracted folder (e.g. cd kryptor-linux).

  4. Mark the kryptor file as executable using chmod +x kryptor.

  5. Type ./kryptor --help for a list of commands and some examples.

When referencing file paths/file names that contain spaces, you must surround them with 'apostrophes' like so:

$ ./kryptor -e -p 'GitHub Logo.png'
$ ./kryptor -e -p '/home/samuel-lucas6/Downloads/GitHub Logo.png'

I recommend moving the kryptor file into /home for easier access from the terminal.

Do not move the kryptor file into a directory that requires root privileges.

Building Kryptor from source

Before you do anything with the source code, make sure you understand the GPLv3 license used by Kryptor. Click here for a summary of GPLv3.​​

Downloading the source code

  1. Go to the latest release on GitHub and download the Source code (zip) asset.

  2. Navigate to the download location and extract the ZIP file.

Using Visual Studio

  1. After extracting the soure code ZIP file, navigate to the src folder, and open the KryptorCLI.sln file in Visual Studio 2019 Community.

  2. Right click on KryptorCLI in the Solution Explorer and click on Publish... .

  3. Choose to publish Kryptor as either win-x64, linux-x64, or osx-x64. Then click Publish. You will find the published executable at the path listed next to Target location.

Note that the libsodium library requires the Visual C++ Redistributable for Visual Studio 2015-2019 to work on Windows. Therefore, you must keep the x64 vcruntime140.dll file in the same folder as kryptor.exe on Windows.​

I do not recommend changing the publish profile settings, but you can tweak them to publish the application as Framework-dependent, change the target location (output path), etc via the pencil icons.

Using the .NET CLI

  1. Install the latest .NET 5 SDK.

  2. Navigate to the src folder in the terminal (e.g. cd C:\Users\samuel-lucas6\Downloads\Kryptor-3.0.3\src).

  3. Copy and paste the following command for the operating system you would like to build for:

Windows (x64)

$ dotnet publish -c Release -r win-x64 -p:PublishSingleFile=true -p:PublishTrimmed=true -p:IncludeNativeLibrariesForSelfExtract=true --self-contained true

Linux (x64)

$ dotnet publish -c Release -r linux-x64 -p:PublishSingleFile=true -p:PublishTrimmed=true -p:IncludeNativeLibrariesForSelfExtract=true --self-contained true

macOS (x64)

$ dotnet publish -c Release -r osx-x64 -p:PublishSingleFile=true -p:PublishTrimmed=true -p:IncludeNativeLibrariesForSelfExtract=true --self-contained true

The output path defaults to [project_file_folder]/bin/[configuration]/[framework]/[runtime]/publish/ .

A full list of .NET CLI options can be found here.