Welcome to Nuclei Tool User Guide!

Contents

• 1. Introduction
• 2. Nuclei Studio IDE
  • 2.1. Introduction to Nuclei Studio IDE
  • 2.2. Nuclei Studio Release Notes
    • 2.2.1. 2026.10 Release Notes
    • 2.2.2. 2025.10 Release Notes
    • 2.2.3. 2025.02 Release Notes
    • 2.2.4. 2024.06 Release Notes
    • 2.2.5. 2024.02.dev Release Notes
    • 2.2.6. 2023.10 Release Notes
    • 2.2.7. 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. CPU Information
    • 2.9.7. Flash Programming
    • 2.9.8. Flash Erase
  • 2.10. Nuclei Studio Advanced Features
    • 2.10.1. Importing Projects Created by Older Versions
    • 2.10.2. Extension Selector
    • 2.10.3. LST View
    • 2.10.4. Code Coverage and Profiling
    • 2.10.5. Trace
    • 2.10.6. Flame View
    • 2.10.7. Using RVProf
    • 2.10.8. Nuclei NICE Wizard
    • 2.10.9. Using Nuclei Model Debugger
    • 2.10.10. Using Nuclei Model
    • 2.10.11. Nuclei Near Cycle Model
    • 2.10.12. Using GDB Custom Debugger
    • 2.10.13. Using Live Watch
    • 2.10.14. Live Peripheral
    • 2.10.15. Flash Programming
    • 2.10.16. Flash Erase
    • 2.10.17. Connect to Running Target
    • 2.10.18. Updating evalsoc in Nuclei QEMU
    • 2.10.19. Switching from GCC to Clang/ZCC
    • 2.10.20. CPU Information
    • 2.10.21. MMU View
    • 2.10.22. RISC-V Reference
    • 2.10.23. GDB Breakpoint Project Filter Option
    • 2.10.24. Memory View Address Exclusion
    • 2.10.25. Big Endian Compiler Support
    • 2.10.26. Register View Filter
    • 2.10.27. Disassembly View C Code Linkage
  • 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.12.35. How to View GDB Trace
  • 2.13. Other Issues Without a Noted Version
  • 2.14. Known Issues
    • 2.14.1. Known Issues in 2026.10
• 3. Nuclei Studio VSCode
  • 3.1. Introduction to Nuclei Studio VSCode
    • 3.1.1. Features
    • 3.1.2. The Nuclei Studio VSCode View Container
    • 3.1.3. Requirements
    • 3.1.4. Extension Settings
  • 3.2. Changelog
    • 3.2.1. Version 2026.10
  • 3.3. Nuclei Studio VSCode Download and Installation
    • 3.3.1. Install Nuclei Studio IDE
    • 3.3.2. Install the Extension in VS Code
    • 3.3.3. The Getting Started Walkthrough
    • 3.3.4. Configure the Nuclei Studio IDE Installation Folder
  • 3.4. NPK Package Management in Nuclei Studio VSCode
    • 3.4.1. Opening the NPK Package Management Page
    • 3.4.2. Managing Packages
  • 3.5. Create a Project in Nuclei Studio VSCode
    • 3.5.1. Workspaces and Projects
    • 3.5.2. Create a Project with the New Project Wizard
    • 3.5.3. Create a Hello World Project
    • 3.5.4. Import a Project
    • 3.5.5. Export a Project
    • 3.5.6. Manage Projects
  • 3.6. Build a Project in Nuclei Studio VSCode
    • 3.6.1. Build, Clean, and Rebuild
    • 3.6.2. Build Configurations
    • 3.6.3. Build or Clean Selected Files
    • 3.6.4. Exclude Resources from the Build
    • 3.6.5. Toolchains
  • 3.7. Debug and Run a Project in Nuclei Studio VSCode
    • 3.7.1. Debug Schemes
    • 3.7.2. Start Debugging
    • 3.7.3. Launch Configuration Editors
    • 3.7.4. Run Without Debugging
    • 3.7.5. Serial Monitor and Debug Views
    • 3.7.6. Limitations
  • 3.8. Advanced Usage of Nuclei Studio VSCode
    • 3.8.1. Live Watch
    • 3.8.2. Nuclei Settings
    • 3.8.3. Project Properties and Resource Properties
    • 3.8.4. Open Terminal
    • 3.8.5. IntelliSense
    • 3.8.6. Project Conversion
  • 3.9. Nuclei Studio VSCode Update and Upgrade
    • 3.9.1. Update the Extension
    • 3.9.2. Update the Nuclei Studio IDE and Tools
    • 3.9.3. Update NPK Packages
    • 3.9.4. Update the RISC-V Extension Data
  • 3.10. Nuclei Studio VSCode FAQ
    • 3.10.1. The Nuclei Studio VSCode Icon Does Not Appear in the Activity Bar
    • 3.10.2. VS Code Reports That the Workspace Is in Restricted Mode
    • 3.10.3. A “Configure Nuclei Studio Install Folder” Warning Is Shown in the WELCOME Panel
    • 3.10.4. “Please install the required NPK packages first.” When Creating a Project
    • 3.10.5. “Current workspace differs from Nuclei Studio VSCode workspace.”
    • 3.10.6. Build Fails Because the Toolchain or make Cannot Be Found
    • 3.10.7. The Debug Session Does Not Start
    • 3.10.8. Live Watch Reports That the Feature Is Not Supported
    • 3.10.9. Rebuild Index Reports That the C/C++ Extension Is Not Available
    • 3.10.10. “Debug As…” Is Not Available for a Launch File
    • 3.10.11. Where Are the NPK Packages Installed
• 4. Nuclei Toolchain
  • 4.1. GNU Toolchain
    • 4.1.1. About GNU Toolchain
    • 4.1.2. Extensions Support
    • 4.1.3. General Options
    • 4.1.4. Nuclei Custom Options
    • 4.1.5. Libraries
    • 4.1.6. Changelog
    • 4.1.7. Install and Setup
    • 4.1.8. Testsuite
    • 4.1.9. Checking GNU Version
    • 4.1.10. Known Issues
    • 4.1.11. Nuclei Custom BFloat16 Extension
    • 4.1.12. Nuclei Custom VPU Extension
    • 4.1.13. Nuclei Custom Xxlvw Extension
  • 4.2. LLVM Toolchain
    • 4.2.1. About LLVM Toolchain
    • 4.2.2. Extensions Support
    • 4.2.3. General Options
    • 4.2.4. Nuclei Custom Options
    • 4.2.5. Install and Setup
    • 4.2.6. Changelog
    • 4.2.7. Checking LLVM Version
    • 4.2.8. Known Issues
  • 4.3. Changelog
    • 4.3.1. Version 2026.10
    • 4.3.2. Version 2025.10
    • 4.3.3. Version 2025.02
    • 4.3.4. Version 2024.06
• 5. Nuclei C Runtime Library
  • 5.1. About Nuclei C Runtime Library
  • 5.2. Nuclei C Runtime Library for Nuclei Toolchain
    • 5.2.1. Usage
    • 5.2.2. zicfilp landing pad usage
    • 5.2.3. Big-endian usage
    • 5.2.4. Varieties
  • 5.3. Quick start
    • 5.3.1. exit()
    • 5.3.2. Basic UART I/O functions (-lfileops_uart)
    • 5.3.3. Using Semihosting (-lfileops_semi)
    • 5.3.4. Using RTT (-lfileops_rtt)
    • 5.3.5. Thread-local storage
    • 5.3.6. Heap
  • 5.4. Runtime support
    • 5.4.1. Getting to main() and then exit()
    • 5.4.2. Multithreaded protection for the heap
  • 5.5. Using customized fileops
  • 5.6. C library API
    • 5.6.1. <assert.h>
    • 5.6.2. <complex.h>
    • 5.6.3. <ctype.h>
    • 5.6.4. <errno.h>
    • 5.6.5. <fcntl.h>
    • 5.6.6. <fenv.h>
    • 5.6.7. <float.h>
    • 5.6.8. <iso646.h>
    • 5.6.9. <limits.h>
    • 5.6.10. <locale.h>
    • 5.6.11. <malloc.h>
    • 5.6.12. <math.h>
    • 5.6.13. <setjmp.h>
    • 5.6.14. <stdalign.h>
    • 5.6.15. <stdbool.h>
    • 5.6.16. <stddef.h>
    • 5.6.17. <stdint.h>
    • 5.6.18. <stdio.h>
    • 5.6.19. <stdlib.h>
    • 5.6.20. <string.h>
    • 5.6.21. <time.h>
    • 5.6.22. <unistd.h>
    • 5.6.23. <wchar.h>
    • 5.6.24. <wctype.h>
    • 5.6.25. <xlocale.h>
  • 5.7. Compiler support API
    • 5.7.1. GNU library API
  • 5.8. External function interface
    • 5.8.1. I/O functions
    • 5.8.2. Heap protection functions
    • 5.8.3. Error and assertion functions
    • 5.8.4. RTC functions
    • 5.8.5. Locale functions
  • 5.9. Changelog
    • 5.9.1. Version 2026.10
    • 5.9.2. Version 2025.02
    • 5.9.3. Version 2024.06
    • 5.9.4. Version 2023.10
  • 5.10. Known Issues
    • 5.10.1. Version 2026.10
    • 5.10.2. Version 2025.02
    • 5.10.3. Version 2024.06
• 6. Nuclei OpenOCD
  • 6.1. OpenOCD Usage Guide
    • 6.1.1. Table of Contents
    • 6.1.2. Tool Installation and Environment Setup
    • 6.1.3. Repositories and Documentation
    • 6.1.4. Getting Started
    • 6.1.5. Nuclei-Specific Features
    • 6.1.6. Configuration File Overview
    • 6.1.7. Low-Cost Debugger Solution
    • 6.1.8. Frequently Asked Questions
    • 6.1.9. Common Problem Troubleshooting and Solutions
    • 6.1.10. Changelog
    • 6.1.11. Known Issues
    • 6.1.12. Other Debuggers
  • 6.2. OpenOCD Capture Trace Data
    • 6.2.1. Table of Contents
    • 6.2.2. Tool Installation and Environment Setup
    • 6.2.3. ETrace Version Overview
    • 6.2.4. Etrace Command Reference
    • 6.2.5. Trace Command Reference
    • 6.2.6. Common Problem Troubleshooting and Solutions
  • 6.3. TraceDecoder Decoding Trace Data
    • 6.3.1. Table of Contents
    • 6.3.2. Tool Installation and Environment Setup
    • 6.3.3. Features
    • 6.3.4. Command Line Usage
    • 6.3.5. Usage Examples
    • 6.3.6. Common Problem Troubleshooting and Solutions
    • 6.3.7. Changelog
• 7. Nuclei QEMU
  • 7.1. About Nuclei QEMU
  • 7.2. Design and Architecture
    • 7.2.1. Nuclei CPU Types Supported on QEMU
    • 7.2.2. Address Allocation of EvalSoC on QEMU
    • 7.2.3. Nuclei CPU and SoC Features Supported on QEMU
  • 7.3. Nuclei QEMU Command-line Options
    • 7.3.1. Command-line Syntax and Help
    • 7.3.2. EvalSoC Machine Configuration
    • 7.3.3. CPU Configuration
    • 7.3.4. Memory and CPU Count
    • 7.3.5. Boot and Image Loading
    • 7.3.6. Console and Character Devices
    • 7.3.7. Storage
    • 7.3.8. Networking
    • 7.3.9. Plugins
    • 7.3.10. Execution and Timing
    • 7.3.11. Debugging
  • 7.4. Use Nuclei QEMU in Nuclei SDK
  • 7.5. Use Nuclei QEMU in Nuclei Linux SDK
  • 7.6. Nuclei XEC Ethernet User Guide
    • 7.6.1. User Mode Networking
    • 7.6.2. TAP Mode Networking
  • 7.7. Nuclei NICE Plugin
    • 7.7.1. How to Load the NICE Plugin
    • 7.7.2. How to Extend user_nice.c
    • 7.7.3. Usage Notes
  • 7.8. Changelog
    • 7.8.1. Version 2026.10
    • 7.8.2. Version 2025.10
    • 7.8.3. Version 2025.02
  • 7.9. Known Issues
    • 7.9.1. Open Known Issues
    • 7.9.2. Fixed issues on Nuclei QEMU 2026.10
• 8. Nuclei Model
  • 8.1. About Nuclei Near Cycle Model
  • 8.2. Design and Architecture
    • 8.2.1. SystemC components
    • 8.2.2. Address Allocation of Evalsoc in xlmodel
    • 8.2.3. Nuclei CPU Features Supported in xlmodel
    • 8.2.4. Nuclei SDK Cases Supported in xlmodel
  • 8.3. Nuclei Model Command-line Options
    • 8.3.1. Command-line Syntax and Help
    • 8.3.2. CPU Configuration
    • 8.3.3. SoC Configuration
    • 8.3.4. soc-cfg JSON Configuration
    • 8.3.5. Memory Configuration
    • 8.3.6. Simulation Speed and Time
    • 8.3.7. Trace, Profiling and Logs
  • 8.4. DEBUG
  • 8.5. Semihosting
  • 8.6. Use Nuclei Model in Nuclei SDK
  • 8.7. Use Nuclei Model in Nuclei Linux SDK
  • 8.8. NICE support
    • 8.8.1. NICE build
    • 8.8.2. NICE example
  • 8.9. SystemC integration
  • 8.10. Changelog
    • 8.10.1. Version 2026.10
    • 8.10.2. Version 2025.10
    • 8.10.3. Version 2025.02
• 9. ChangeLog
  • 9.1. 2026.10
  • 9.2. 2025.10
  • 9.3. 2025.02
  • 9.4. 2024.06
  • 9.5. 2024.02
  • 9.6. 2023.10
• 10. Glossary
• 11. Appendix

Indices and tables

• Index

• Search Page