BOXER(1p)

📦
version 1.4.3 · 4 versions
, in ubuntu resolute, ubuntu stonking

💖 BOXER 💖

okay bestie, welcome to the boxer man page — she's a Perl script from the User Contributed Perl Documentation corner of the internet and she is so much cooler than she looks, fr fr. sit down, grab a strawberry 🍓, and let's get into it.

✨ NAME ✨

boxer — the boxer command line utils, periodt. 👑

🌸 VERSION 🌸

Version v1.4.3

🦋 SYNOPSIS 🦋

$ boxer compose parl-greens
Done: composed preseed.cfg and script.sh for a DebianParl system

$ boxer bootstrap lxp5
Done: created rootfs for lxp5 node

# TODO: below command are not yet implemented

$ boxer install
[...]
Done: Installed "Debian GNU/Linux 11 (bullseye)" to /media/boxer

$ boxer install --arch armhf --classes swedish kde webdesign
[...]
Done: Installed "Debian GNU/Linux 11 (bullseye)" to /media/boxer

$ boxer detect
Analyzing current system...
Report and custom class saved below directory /tmp/boxer.wcJxHnql6f

$ boxer refresh --script ~/refresh.sh
Shell script (to be executed by root) saved as ~/refresh.sh
heads up bestie: that # TODO: below command are not yet implemented line is literally in the docs — boxer install is still in its WIP era, don't come for me. 😭

🎀 DESCRIPTION 🎀

so boxer is like, one single front-end for a whole bunch of "boxing" tasks — which is the fancy way of saying structured system-wide tasks that usually get applied in batch to big deployments. it's giving orchestration, but make it a Perl script. 💅

here's the thing that makes her different. tools like Puppet, CFEngine and Chef? they operate on top of an already-installed system. boxer preferrably interacts with the packaging system of the system itself. different vibe entirely.

she's inspired by Fully Automated Installer (FAI), and the classes are modelled after that tool too. BUT — and this is the main character energy right here — the actual goal of boxer is to become obsolete. for real. she wants to be unneeded. boxer can include custom tweaks, but she encourages you to avoid them and instead pass upstream to distro designers the customizations that are actually needed. icon status tbh.

the core distribution ships with commands to analyze, initialize and refresh a Debian(-based) operating system. 🫶

and she's pluggable!! it is anticipated that plugins on CPAN will cover other related tasks. slay.

👑 COMMANDS 👑

this section describes the commands included with the core Boxer::CLI distribution. others are available as plugins. run boxer commands to see a list of locally installed commands. iykyk.

⭐ Meta Commands ⭐

  • boxer about — shows the version numbers of all installed boxer commands, plus the CPAN ID of each command's author. everyone gets credit, as they should. 💖
  • boxer aliases — many commands have aliases or shortcuts. for example, these two are equivalent:
$ boxer install --arch armhf --classes swedish
$ boxer deploy --arch armhf --classes swedish

boxer aliases shows a list of available aliases. same energy, different name bestie. ✨

  • boxer commands — shows a list of installed boxer commands, along with a brief extract.
  • boxer help — running the boxer help command on its own shows a list of commands with their abstracts. want the detailed help for one specific command? just pass it as an argument. for example, for help on the boxer detect command, run:
$ boxer help detect

🔥 System creation/manipulation 🔥

  • boxer install
  • boxer update

💜 Class handling 💜

  • boxer enable
  • boxer disable
  • boxer analyze

🌈 Class exchange 🌈

  • boxer pull
  • boxer push
  • boxer publish

🌸 SEE ALSO 🌸

Find Boxer::CLI plugins on MetaCPAN: <https://metacpan.org/search?q=Boxer::CLI::Command>

💖 AUTHOR 💖

Jonas Smedegaard <dr@jones.dk>.

give her the credit, she wrote all of this. 👏

Copyright © 2013-2016 Jonas Smedegaard

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

💀 DISCLAIMER OF WARRANTIES 💀

THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.

okay this one is in ALL CAPS for a reason bestie — no warranty, no promises, she said what she said. 😭

and that's the whole page!! ✨ this beauty was built with perl v5.40.1 and stamped 2026-01-27 — shoutout to the BOXER(1p) era, we love her, we stan, mwah 💋🫶

📦 where this page comes from