xdg-ninja(1)

📦 version 0.2.0.2-unstable-2026-10, in nixpkgs unstable

💅 NAME 💅

xdg-ninja — because you wouldn't let just anyone into your $HOME 🏠✨ (fr fr, it's a whole vibe check for your home directory)

🎀 SYNOPSIS 🎀

xdg-ninja [OPTIONS]
xdg-ninja -h|--help

🦋 DESCRIPTION 🦋

Okay so picture this: it's a shell script, right? And what it does is it goes through your $HOME looking for unwanted files and directories. Like, uninvited guests at your party. 💀 Not cute.

Bestie, listen — the script is designed to provide change recommendations and does not make any modifications to the system itself. It literally just tells you what's up. It does not touch anything. Your files are safe, iykyk. 🫶

This program has optional runtime dependencies that can modify and improve the visual output. The recommended dependency for best results is glow ✨ — so if you want it looking all pretty and glowing, that's the one. 🌟

✨ OPTIONS ✨

  • -v, --no-skip-ok — Display messages for all files checked (verbose). Full main character energy: nothing gets skipped, everything gets screen time. 👑
  • --skip-ok — Don't display anything for files that do not exist (default behavior). If it's not there, we don't talk about it. 🙈
  • --skip-unsupported — Don't display anything for files that do not have fixes available. No fix? No shoutout. 💀
  • --skip-user — Don't display anything for files that the user ignores (default). Don't display basenames in $XN_IGNOREFILE or $XDG_CONFIG_HOME/xdg-ninja/ignore. Overridden by --skip-ok.
  • --no-skip-user — Don't ignore files that the user specified in the ignorefile. Yeah bestie, we're un-ignoring them. 🫣

🌈 ENVIRONMENT VARIABLES 🌈

  • $XN_PROGRAMS_DIR= — Overwrites the path where programs information are located (default: programs/ or ../share/xdg-ninja/programs/) 🗂️
  • $XN_IGNOREFILE= — Is read instead of $XDG_CONFIG_HOME/xdg-ninja/ignore or $HOME/.config/xdg-ninja/ignore. The ignorefile is a plain text file with the basenames of files that xdg-ninja will not render a warning for unless --skip-ok or --no-skip-user is specified. 📝 (basically your personal "do not disturb" list, and we respect it 💅)

Licensed under the MIT license <http://opensource.org/licenses/MIT>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. 😭 (read that again, no cap — no warranty fr)

🍓 SEE ALSO 🍓

Sources, bug report, and more are available at <https://github.com/b3nj5m1n/xdg-ninja>. 🌸

Okay that's the whole page, bestie — brought to you by b3nj5m1n, dated May 2026, and it's the xdg-ninja manual in case you forgot where you were. Now go clean up your $HOME 🧚💜

📦 where this page comes from