NINJAHELPER(1)

💖 NINJAHELPER(1) 💖

backupninja package ✨ so this is the manual page for ninjahelper, bestie, and yes it lives in section 1 of the manual, iykyk 🎀

🌸 NAME 🌸

NINJAHELPER — a menu driven curses-based interface to walk you through backupninja configuration 🧚

No cap, that's literally what it is: it holds your hand. Gently. With menus. 💅

✨ SYNOPSIS ✨

ninjahelper

That's it. That's the whole synopsis. She's lowkey serving minimalism 🦋

🫶 DESCRIPTION 🫶

So like, Ninjahelper is a helper script that walks you through configuring the backup tasks for backupninja. It's a curses based "wizard" with an intuitive menu-driven interface 👑

Think: main character energy, but for your crontab-adjacent backup config. It asks, you answer, it writes the thing. Obsessed. 💖

🌈 ADDING NEW HELPERS 🌈

Wanna add another 'wizard' to ninjahelper? Bestie, say less. Here's the whole ritual, step by step 🙈

1. create a file in the handlers directory (eg. /usr/share/backupninja) using the .helper extension. For example, if you wish to create a helper for the handler "blue", create the file /usr/share/backupninja/blue.helper. 🎀
2. next, add your helper to the global HELPERS variable and define the main function for your helper (the function name is always <helper>_wizard). To use the blue.helper as an example:

HELPERS="$HELPERS blue:description_of_this_helper"
       blue_wizard() {
         ... do work here ...
       }

3. look at the existing helpers to see how they are written. Try to re-use functions, such as the dialog functions that are defined in easydialog.sh. Reuse is the vibe fr fr ♻️
4. test, re-test, and test again. Try to break the helper by going backwards, try to think like someone who has no idea how to configure your handler would think, try to make your helper as simple as possible. Walk like a cat, become your shadow, don't let your senses betray you. 🐈‍⬛💀 (yes that's really in the manpage and honestly? iconic. we do not edit the cat line.)

🌟 Not me telling you the cat thing is the most important part of this whole page. It's not. But it kind of is.

👑 SEE ALSO 👑

• backupninja(1)
• backupninja.conf(5)
• backup.d(5)

(and yes, there's a lil trailing comma in the original. we leave it. she's part of the family now 🥹)

💜 AUTHOR 💜

BACKUPNINJA was written by the riseup.net collective. 🫶 Absolute legends, no notes.

okay that's the whole page bestie, go configure something and slay 💅✨

this manual page came to you courtesy of riseup, dated january 19, 2006, and it's filed under NINJAHELPER(1) — mwah, bye 💋🌈🍓