ntxbuild Documentation

NuttX Build System Assistant - A Python tool for managing and building NuttX RTOS projects with ease.

ntxbuild is simply a wrapper around the many tools available in the NuttX repository. It wraps around tools such as make, kconfig-tweak, menuconfig and most used bash scripts (such as configure.sh).

This tool provides a command line interface that supports NuttX configuration and building, while also providing a Python API that allows you to script your builds.

Contents

• Quick Start
  • 1. Prepare the source code
  • 2. Initialize Your NuttX Environment
  • 3. Build Your Project
  • 4. Configure Your Build
  • Using Python
  • View Available Boards and Configs
  • Downloading Toolchains
• Project Features
  • Basic NuttX Scripts Wrapper
  • Toolchain Management
  • CMake Support
  • Real-time Build Output
  • Lightweight Workspace Copies
  • Board Explorer
  • Curses Support
  • To-Do
• API Examples
  • Configuring and Building (Make)
  • CMake-based workflow (CMakeBuilder)
  • Apply custom options
  • Copying nuttxspace
  • List available boards and defconfigs with Board Explorer
• API Reference
  • Build Module
  • Configuration Module
  • Environment Data Module
  • CLI Module
  • Setup Module
  • Toolchains Module
  • Utilities Module
  • NuttX Module
  • Module contents
• Command Line Usage
  • start
  • build
  • menuconfig
  • kconfig
  • install
  • clean
  • distclean
  • info
• How It Works
  • Environment Setup
  • Setting KConfig Options
  • Building
  • Cleaning Environment