Installing Capsule

Capsule is provided as a pre-built binary for installation in popular operating systems or it can be built from source.

Supported Environments

• Linux
• MacOS
• Windows (Requires Windows Subsystem Linux 2 (WSL2))

Prerequisites

The following must be installed and available to use Capsule.

• Docker - Capsule uses docker to build contracts and run tests. https://docs.docker.com/get-docker/
• ckb-cli (optional) - Capsule requires ckb-cli to enable the smart contract deployment feature. https://github.com/nervosnetwork/ckb-cli/releases

Note: docker and ckb-cli must be accessible in the PATH in order for them to be used by Capsule.

Note: The current user must have permission to manage Docker instances. How to manage Docker as a non-root user.

Installing a Prebuilt Binary

Most users will want to install a prebuilt binary.

• Download a release from GitHub.
• Decompress the downloaded archive.
• Move the binary to /usr/local/bin or the appropriate folder for your distro.

The capsule command should then be accessible from the command line.

Building from Source Code

Tested Build Environments

Capsule should be able to be built on most Linux and MacOS platforms. Below are the platforms which have been officially tested and verified for successful building along with their specific requirements.

• CentOS 8
• Fedora Workstation 32
• Debian 10
• MacOS 10.13.1
• OpenSUSE Leap v15.1
• Ubuntu 18.04
• Ubuntu 20.04

All Platforms

• Rust https://rustup.rs/

CentOS / Fedora

• OpenSSL Development Kit

Install the above dependencies: sudo yum install openssl-devel

Debian / Ubuntu

• Build Tools
• Curl
• Git
• OpenSSL Development Kit
• Pkg-config

Install the above dependencies: sudo apt install -y build-essential curl git libssl-dev pkg-config

MacOS

• Xcode Command Line Tools https://developer.apple.com/library/archive/technotes/tn2339/

OpenSUSE

• Development Basis
• OpenSSL Development Kit

Install the above dependencies:

• sudo zypper install -t pattern devel_basis
• sudo zypper install libopenssl-devel

Build and Install Capsule

Execute the following to install Capsule for the current non-priviledged user.

cargo install capsule --git https://github.com/nervosnetwork/capsule.git --tag v0.1.3