Skip to main content

Prerequisites

Dokrypt requires Docker (or Podman) running on your machine. All chains and services run as containers.
  • Docker Desktop (macOS/Windows) or Docker Engine (Linux)
  • Docker API version 1.41 or higher
  • At least 5 GB of free disk space
Verify Docker is running:
docker info
The simplest way to install Dokrypt. Works on macOS, Linux, and Windows.
npm install -g dokrypt
This installs the correct platform-specific binary automatically. Supported platforms:
OSArchitecturePackage
Linuxx64@dokrypt/linux-x64
LinuxARM64@dokrypt/linux-arm64
macOSIntel@dokrypt/darwin-x64
macOSApple Silicon@dokrypt/darwin-arm64
Windowsx64@dokrypt/win32-x64
Verify the installation:
dokrypt version

Install via Docker

Run Dokrypt directly as a Docker container:
docker pull ghcr.io/dokrypt-org/dokrypt:latest
Run commands with:
docker run --rm -v /var/run/docker.sock:/var/run/docker.sock \
  -v $(pwd):/workspace -w /workspace \
  ghcr.io/dokrypt-org/dokrypt:latest init my-project
The Docker method requires mounting the Docker socket (/var/run/docker.sock) so Dokrypt can manage containers.

Install from Binary

Download pre-built binaries from GitHub Releases.
# Linux x64
curl -L https://github.com/dokrypt-org/dokrypt/releases/latest/download/dokrypt_0.1.0_linux_amd64.tar.gz | tar xz
sudo mv dokrypt /usr/local/bin/

# macOS Apple Silicon
curl -L https://github.com/dokrypt-org/dokrypt/releases/latest/download/dokrypt_0.1.0_darwin_arm64.tar.gz | tar xz
sudo mv dokrypt /usr/local/bin/

# macOS Intel
curl -L https://github.com/dokrypt-org/dokrypt/releases/latest/download/dokrypt_0.1.0_darwin_amd64.tar.gz | tar xz
sudo mv dokrypt /usr/local/bin/

# Verify
dokrypt version

Build from Source

Requires Go 1.24+.
git clone https://github.com/dokrypt-org/dokrypt.git
cd dokrypt
make build
The binary will be at ./bin/dokrypt. Move it to your PATH:
sudo mv ./bin/dokrypt /usr/local/bin/

Verify Installation

Run the built-in diagnostics to check that everything is set up correctly:
dokrypt doctor
This checks:
  • Docker is installed and running
  • Docker API version meets minimum requirements
  • Sufficient disk space is available
  • Required ports (8545, 5001, 8080, 4000, etc.) are available
Example output:
Dokrypt Doctor
Platform: linux/amd64

✓ Docker installed
✓ Docker daemon running
✓ Docker API version 1.45 (minimum 1.41)
✓ Disk space: 45 GB free (minimum 5 GB)
✓ Port 8545 available
✓ Port 5001 available
✓ Port 8080 available
✓ Port 4000 available
✓ Port 8000 available
✓ Port 6688 available
✓ Port 3000 available

All checks passed!

Updating

# npm
npm update -g dokrypt

# Docker
docker pull ghcr.io/dokrypt-org/dokrypt:latest

Uninstalling

# npm
npm uninstall -g dokrypt

# Binary
sudo rm /usr/local/bin/dokrypt

# Clean up data directory
rm -rf ~/.dokrypt