Welcome to Nuclei Tool User Guide!

Warning

This documentation is under active development for the upcoming 2026.10 release. Its content is not a formal release and is subject to change at any time.

Contents

• 1. Introduction
• 2. Nuclei Studio IDE
  • 2.1. Introduction to Nuclei Studio IDE
  • 2.2. Nuclei Studio Release Notes
    • 2.2.1. 2025.10 Release Notes
    • 2.2.2. 2025.02 Release Notes
    • 2.2.3. 2024.06 Release Notes
    • 2.2.4. 2024.02.dev Release Notes
    • 2.2.5. 2023.10 Release Notes
    • 2.2.6. 2022.12 Release Notes
  • 2.3. Nuclei Studio Download and Installation
    • 2.3.1. Nuclei Studio IDE Download
    • 2.3.2. Nuclei Studio IDE Installation
    • 2.3.3. Launching Nuclei Studio IDE
  • 2.4. Nuclei Studio NPK Overview
    • 2.4.1. Package Description File (npk.yml)
    • 2.4.2. Section Overview
    • 2.4.3. UI Components in NPK
    • 2.4.4. NPK Syntax
  • 2.5. Nuclei Studio NPK Creation and Sharing
    • 2.5.1. Develop an NPK Component Package
    • 2.5.2. Checking and Troubleshooting NPK Component Packages
    • 2.5.3. Share an NPK Component Package
    • 2.5.4. Using NPK Component Packages in Nuclei Studio
  • 2.6. Nuclei Studio NPK Applications
    • 2.6.1. NPK Package Management
    • 2.6.2. Create a Project via NPK
    • 2.6.3. Import Tools via NPK
  • 2.7. Create a Project in Nuclei Studio
    • 2.7.1. Automatically Create a Project Using an NPK Template Project
    • 2.7.2. Import a Project via an Application Association File
    • 2.7.3. Import an Existing Project Directly to Create a New Project
    • 2.7.4. Manually Create a Project Without a Template
    • 2.7.5. Create a Project Based on an Existing Makefile
  • 2.8. Build a Project in Nuclei Studio
    • 2.8.1. Build Tools
    • 2.8.2. Nuclei SDK Project Settings Tool
    • 2.8.3. Build the Hello World Project in Nuclei Studio
  • 2.9. Debugging and Running Projects in Nuclei Studio
    • 2.9.1. Debug Mode Management
    • 2.9.2. Debugging and Running a Project with the HummingBird Debugger and OpenOCD
    • 2.9.3. Debugging and Running a Project with J-Link
    • 2.9.4. Debugging and Running a Project with DLink
    • 2.9.5. Connect to Running Target
    • 2.9.6. Flash Programming
  • 2.10. Nuclei Studio Advanced Features
    • 2.10.1. Importing Projects Created by Older Versions
    • 2.10.2. LST View
    • 2.10.3. Code Coverage and Profiling
    • 2.10.4. Using the Trace Feature
    • 2.10.5. Using RVProf
    • 2.10.6. Nuclei NICE Wizard
    • 2.10.7. Using the Nuclei Model Debugger
    • 2.10.8. Using Nuclei Model
    • 2.10.9. Nuclei Near Cycle Model
    • 2.10.10. Using the GDB Custom Debugging Feature
    • 2.10.11. Using Live Watch
    • 2.10.12. Using Flame View
    • 2.10.13. Flash Programming
    • 2.10.14. Connect to Running Target
    • 2.10.15. Updating evalsoc Configuration in Nuclei QEMU
    • 2.10.16. Switching From the GNU GCC Toolchain to the Clang/ZCC Toolchain
  • 2.11. Nuclei Studio Update and Upgrade
    • 2.11.1. Online Update
    • 2.11.2. Manual Update
  • 2.12. Nuclei Studio FAQ
    • 2.12.1. Nuclei Studio Starts Slowly
    • 2.12.2. Nuclei Studio Builds Programs Slowly
    • 2.12.3. Cannot Find the New Nuclei RISC-V C/C++ Project Menu
    • 2.12.4. Opening/Closing the Launch Bar
    • 2.12.5. Using the Launch Bar
    • 2.12.6. Running/Debugging Without the Launch Bar
    • 2.12.7. Viewing Registers in the Debug Perspective
    • 2.12.8. Terminating Processes in the Debug Perspective
    • 2.12.9. Functions of the Buttons in the Nuclei Studio Toolbar
    • 2.12.10. Showing Other Windows
    • 2.12.11. Restoring the Default Window Layout
    • 2.12.12. Comparing with File History
    • 2.12.13. Possible Errors When Creating a Project
    • 2.12.14. Cached Paths When Adding an Include Path
    • 2.12.15. Cannot Find a Settings Page Section
    • 2.12.16. Slow Download Speed to the Development Board
    • 2.12.17. Multiple Users Using Nuclei Studio on Linux
    • 2.12.18. Two Serial Ports Recognized in Device Manager
    • 2.12.19. Error “Could Not Determine GDB Version After Sending: riscv-nuclei-elf-gdb –version, response:” on Linux
    • 2.12.20. Error Reported When Using QEMU on Linux
    • 2.12.21. Error About Missing Symbols When Linking the C Library During Project Build
    • 2.12.22. Build Error: Fatal Error: rvintrin.h: No Such File or Directory
    • 2.12.23. Debug Error: Error: Couldn’t Find an Available Hardware Trigger
    • 2.12.24. Viewing the GDB Trace While Debugging a Project
    • 2.12.25. Connecting to a Running Target While Debugging a Project
    • 2.12.26. Known Defects in Flash Programming
    • 2.12.27. Hardware Check Before Debugging a Project in Nuclei Studio
    • 2.12.28. Nuclei Studio Cannot Debug Due to a Low CPU Frequency
    • 2.12.29. Setting the Nuclei Studio Theme Colors
    • 2.12.30. No Project Creation Menu in the Debug Perspective
    • 2.12.31. Build Error: DWARF Error: Mangled Line Number Section (Bad File Number)
    • 2.12.32. How to Build a Project That Supports Semihosting
    • 2.12.33. How to Debug a Semihosting-Enabled Project with J-Link
    • 2.12.34. Debug Session Hangs Due to Address Preloading in the Memory Window
  • 2.13. Other Issues Without a Noted Version
• 3. Nuclei Toolchain
  • 3.1. GNU Toolchain
    • 3.1.1. About GNU Toolchain
    • 3.1.2. Extensions Support
    • 3.1.3. General Options
    • 3.1.4. Libraries
    • 3.1.5. Changelog
    • 3.1.6. Install and Setup
    • 3.1.7. Checking GNU Version
    • 3.1.8. Known Issues
    • 3.1.9. Nuclei Custom BFloat16 Extension
    • 3.1.10. Nuclei Custom VPU Extension
    • 3.1.11. Nuclei Custom Xxlvw Extension
  • 3.2. LLVM Toolchain
    • 3.2.1. About LLVM Toolchain
    • 3.2.2. Extensions Support
    • 3.2.3. General Options
    • 3.2.4. Install and Setup
    • 3.2.5. Changelog
    • 3.2.6. Checking LLVM Version
    • 3.2.7. Known Issues
  • 3.3. Changelog
    • 3.3.1. Version 2025.10
    • 3.3.2. Version 2025.02
    • 3.3.3. Version 2024.06
• 4. Nuclei C Runtime Library
  • 4.1. About Nuclei C Runtime Library
  • 4.2. Nuclei C Runtime Library for Nuclei Toolchain
    • 4.2.1. Usage
    • 4.2.2. Varieties
  • 4.3. Quick start
    • 4.3.1. exit()
    • 4.3.2. Basic UART I/O functions (-lfileops_uart)
    • 4.3.3. Using Semihosting (-lfileops_semi)
    • 4.3.4. Using RTT (-lfileops_rtt)
    • 4.3.5. Thread-local storage
    • 4.3.6. Heap
  • 4.4. Runtime support
    • 4.4.1. Getting to main() and then exit()
    • 4.4.2. Multithreaded protection for the heap
  • 4.5. Using customized fileops
  • 4.6. C library API
    • 4.6.1. <assert.h>
    • 4.6.2. <complex.h>
    • 4.6.3. <ctype.h>
    • 4.6.4. <errno.h>
    • 4.6.5. <fenv.h>
    • 4.6.6. <float.h>
    • 4.6.7. <iso646.h>
    • 4.6.8. <limits.h>
    • 4.6.9. <locale.h>
    • 4.6.10. <math.h>
    • 4.6.11. <setjmp.h>
    • 4.6.12. <stdbool.h>
    • 4.6.13. <stddef.h>
    • 4.6.14. <stdint.h>
    • 4.6.15. <stdio.h>
    • 4.6.16. <stdlib.h>
    • 4.6.17. <string.h>
    • 4.6.18. <time.h>
    • 4.6.19. <wchar.h>
    • 4.6.20. <wctype.h>
    • 4.6.21. <xlocale.h>
  • 4.7. Compiler support API
    • 4.7.1. GNU library API
  • 4.8. External function interface
    • 4.8.1. I/O functions
    • 4.8.2. Heap protection functions
    • 4.8.3. Error and assertion functions
    • 4.8.4. RTC functions
    • 4.8.5. Locale functions
• 5. Nuclei OpenOCD
  • 5.1. OpenOCD Usage Guide
    • 5.1.1. Table of Contents
    • 5.1.2. Tool Installation and Environment Setup
    • 5.1.3. Repositories and Documentation
    • 5.1.4. Getting Started
    • 5.1.5. Nuclei-Specific Features
    • 5.1.6. Configuration File Overview
    • 5.1.7. Low-Cost Debugger Solution
    • 5.1.8. Frequently Asked Questions
    • 5.1.9. Common Problem Troubleshooting and Solutions
    • 5.1.10. Changelog
    • 5.1.11. Other Debuggers
  • 5.2. OpenOCD Capture Trace Data
    • 5.2.1. Table of Contents
    • 5.2.2. Tool Installation and Environment Setup
    • 5.2.3. ETrace Version Overview
    • 5.2.4. Etrace Command Reference
    • 5.2.5. Trace Command Reference
    • 5.2.6. Common Problem Troubleshooting and Solutions
  • 5.3. TraceDecoder Decoding Trace Data
    • 5.3.1. Table of Contents
    • 5.3.2. Tool Installation and Environment Setup
    • 5.3.3. Features
    • 5.3.4. Command Line Usage
    • 5.3.5. Usage Examples
    • 5.3.6. Common Problem Troubleshooting and Solutions
    • 5.3.7. Changelog
• 6. Nuclei QEMU
  • 6.1. About Nuclei QEMU
  • 6.2. Design and Architecture
    • 6.2.1. Nuclei CPU Types Supported on QEMU
    • 6.2.2. Address Allocation of Evalsoc on QEMU
    • 6.2.3. Nuclei CPU Features Supported on QEMU
  • 6.3. Description of Parameters
  • 6.4. Use Nuclei QEMU in Nuclei SDK
  • 6.5. Use Nuclei QEMU in Nuclei Linux SDK
  • 6.6. Changelog
    • 6.6.1. Version 2025.10
    • 6.6.2. Version 2025.02
  • 6.7. Known Issues
    • 6.7.1. Fixed issues on Nuclei Qemu 2025.10
    • 6.7.2. Remaining issues on Nuclei Qemu 2025.10
  • 6.8. QEMU9.0上XEC以太网使用指南
    • 6.8.1. User模式网络
    • 6.8.2. TAP模式网络
  • 6.9. Nuclei NICE Plugin
    • 6.9.1. How to Load the NICE Plugin
    • 6.9.2. How to Extend user_nice.c
    • 6.9.3. Usage Notes
• 7. Nuclei Model
  • 7.1. About Nuclei Near Cycle Model
  • 7.2. Design and Architecture
    • 7.2.1. SystemC components
    • 7.2.2. Address Allocation of Evalsoc in xlmodel
    • 7.2.3. Nuclei CPU Features Supported in xlmodel
    • 7.2.4. Nuclei SDK Cases Supported in xlmodel
  • 7.3. Description of Parameters
    • 7.3.1. model help
    • 7.3.2. parameter usage
  • 7.4. DEBUG
  • 7.5. NICE support
    • 7.5.1. NICE build
    • 7.5.2. NICE example
  • 7.6. SystemC integration
  • 7.7. Changelog
    • 7.7.1. Version 2025.10
    • 7.7.2. Version 2025.02
• 8. ChangeLog
  • 8.1. 2025.10
  • 8.2. 2025.02
  • 8.3. 2024.06
  • 8.4. 2024.02
  • 8.5. 2023.10
• 9. Glossary
• 10. Appendix

Indices and tables

• Index

• Search Page