Yoctui

A terminal workspace for Yocto developers: build images, inspect what goes into them, edit sources, and debug bring-up without losing your build context. A persistent daemon keeps builds and development terminals available when you close the UI and reconnect later.

Features

Build and diagnose: dashboard and insights, live BitBake tasks, logs, warnings, errors, and saved build history.
Develop: browse layers and recipes, use devtool and devshell, edit text with syntax highlighting, and open GitUI in persistent terminal sessions.
Inspect images: artifacts, rootfs package composition with a pie chart and list, navigable files with permissions and ownership, systemd services, D-Bus, and udev rules.
Bring up hardware: organize project documents and requirements, and record progress through bootloader, kernel, device tree, drivers, and rootfs.
Debug: kernel and U-Boot menuconfig, DTS/DTB tools, QEMU boot, SSH access, and remote kernel debugging with GDB.

Available actions depend on your Yocto build, generated artifacts, and installed tools. See the screenshots and workflows for a closer look.

Install

Linux, an 80×24+ terminal, Python 3, a C compiler/linker, and stable Rust/Cargo are required. Install the official release:

cargo install yoctui --locked -j 2
export PATH="${CARGO_HOME:-$HOME/.cargo}/bin:$PATH"

The published crate may lag the source repository. For the latest checkout, follow Build from source. QEMU, GDB, GitUI, and document viewers are optional tools needed for their respective workflows.

Quickstart

Use a shell initialized for your Yocto build (workspace setup). Check the daemon's workspace first:

yoctui daemon status

If no daemon is running, or it already uses this build:

yoctui daemon start
yoctui --backend bridge --build-dir "$BUILDDIR"

To reconnect to an already-running daemon:

yoctui attach

Press Alt+b to choose/review a build, F1 for Help, or F12 for the menu. Opening Yoctui does not start a build; exiting leaves daemon-owned work running.

Documentation

User guide · Keyboard shortcuts · Screenshots · All documentation

Build from source · Profiling and Flamegraph · Issues · Third-party notices

Contributing

Contributions are welcome, whether you're fixing your first typo or bringing experience from a new board or Yocto release. Bug reports, documentation, workflow feedback, tests, and code all help make Yoctui better.

Open an issue with reproduction steps and your Yocto/build environment, or send a focused pull request. For larger changes, please discuss the approach in an issue first. The development guide covers source builds and verification.