Practical overview
When it fits
Use it when developing CKB scripts and you want editing, compilation, mocked-transaction debugging, and related development utilities in one desktop application.
Who it is for
- Developers authoring or debugging scripts for Nervos CKB.
- Developers who need an IDE workflow alongside CKB key, node, account and transaction tools.
Documented uses
- Create CKB projects from templates and edit scripts.
- Compile JavaScript or C projects and debug them using a configured mocked transaction.
- Create, import and manage CKB keypairs.
- Run CKB nodes and a miner, with options for local, Aggron testnet and CKB mainnet environments.
- View account information and transaction history, and construct CKB transactions.
Requirements & limits
The repository documentation describes packages for macOS, Windows and Linux. The repository identifies the project as GPL-3.0.
- Docker is used to run the CKB node and compiler; first-run setup guides installation of Docker and CKB dependencies.
- JavaScript projects require a manual npm install or yarn step before building.
- The debugger runs a mocked transaction configured in mock/tx.json or project settings.
- The README warns that managed private keys are saved unencrypted and are for development only, not mainnet use.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Build and debug a CKB project
Compile a CKB project and run its configured mocked transaction in the integrated debugger.
Before you start
- CKB Studio and the relevant CKB development dependencies.
- A CKB project; JavaScript projects also require installing project dependencies with npm or Yarn in a terminal.
- A mocked transaction in mock/tx.json or a file specified in project settings.
Steps
Open the project in the CKB Studio editor.
For a JavaScript project, run npm install or yarn in the terminal to install project dependencies.
Select Build in the project toolbar to compile the project.
Select Debug in the toolbar to run the configured mocked transaction.
Expected outcome
The project is compiled and the debugger runs the configured mocked transaction to show the script execution result.
Guide limitations
- The documented build instructions cover JavaScript and C compiler selection; JavaScript dependency installation is a separate manual terminal step.
- Debugging runs a mocked transaction, not a live transaction.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 15 October 2026
- Original website title
- ObsidianLabs/CKB-Studio · Official homepage title · retained in its source language

