Practical overview
When it fits
Use CKB VM when developing or examining script execution for Nervos CKB and a software implementation of RISC-V is needed.
Who it is for
- Developers building or working with Nervos CKB scripts and contracts.
- Engineers who need a software RISC-V execution environment for CKB-related development.
Documented uses
- Build the CKB VM library from source with Cargo.
- Run CKB scripts through its RISC-V-based virtual machine.
- Use the included RISC-V binaries when building the project's tests.
- Work with custom RISC-V binaries, with a RISC-V compiler if one is needed to produce them.
Requirements & limits
The repository is public and identifies the MIT license. The README documents builds with stable Rust and says the project is mainly tested on 64-bit Linux, macOS, and Windows.
- The VM implements RISC-V IMCB instructions with 32-bit and 64-bit register sizes.
- The README recommends ASM mode for consistent behavior and describes Rust mode as a development aid that may differ if bugs occur.
- The develop branch is not guaranteed to be completely stable; the README distinguishes it from released versions used by CKB.
- A RISC-V compiler is unnecessary for building the included test binaries but may be needed for custom binaries.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Build CKB VM from source
Clone the repository and compile CKB VM with Cargo.
Before you start
- Stable Rust, the version documented as mainly tested by the project
- A 64-bit Linux, macOS, or Windows environment
Steps
Clone https://github.com/nervosnetwork/ckb-vm.
Change into the ckb-vm directory.
Run cargo build.
Expected outcome
Cargo builds the CKB VM project from the cloned repository.
Guide limitations
- The README says the develop branch is regularly built and tested but is not guaranteed to be completely stable.
- The documented build prerequisites describe the project's main test environments, not a compatibility guarantee.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 10 October 2026
- Original website title
- nervosnetwork/ckb-vm · Official homepage title · retained in its source language

