BUSKILL(1)

📦
version 0.7.0 · 3 versions
, in debian bookworm, debian trixie, ubuntu noble

💖 BUSKILL — the manual, but make it make sense 💖

okay bestie, welcome to BUSKILL(1), from the Laptop Kill Cord manual section. this is the glow-up version. same facts, way better vibes. let's go 🫶

✨ NAME ✨

buskill — lock or shutdown if your device is stolen (for use with laptop kill cord)

🌸 SYNOPSIS 🌸

buskill [options]

🦋 DESCRIPTION 🦋

okay so. buskill is a cross-platform CLI and GUI app that can lock or shutdown your computer when a USB hotplug removal event occurs. no cap. 🔥

it's designed to work with the BusKill laptop kill cord, which is a hardware dead man switch that tethers a user to their computer via a USB cable with an integrated magnetic breakaway. so picture it: if the cable is disconnected (eg by a snatch-and-run thief stealing the user's machine), then this software can trigger the computer to lock or shutdown — thus protecting encrypted files (eg bitcoin private keys) or current login sessions (eg online banking) from theft. it's giving main character security energy. 👑

💅 OPTIONS 💅

  • -h, --help — show this help message and exit. the classic. the icon. 🎀
  • --version — print version and exit. quick lil flex. ⭐
  • --list-triggers — list all available triggers. yes bestie, see what's on the menu first. 📋
  • -v, --verbose — increase output verbosity. more words, more lore. 🗣️
  • -t, --trigger — choose trigger to execute. see --list-triggers for all possible values. pick your fighter. 🥊
  • -T, --run-trigger — immediately execute the trigger on start. no waiting, we're doing this now. 💥
  • -a, --arm — arms BusKill. 🔒

🌈 EXAMPLES 🌈

buskill --list-triggers — display all possible triggers, then exits. window shopping, but for triggers. 🛍️

buskill --trigger lock-screen --arm — arm the buskill app with the 'lock-screen' trigger so that a USB hotplug removal event will lock the device's screen

buskill --trigger soft-shutdown --arm — arm the buskill app with the 'soft-shutdown' trigger so that a USB hotplug removal event will cause the device to shutdown

👑 SEE ALSO 👑

this manpage is limited in scope. the BusKill project's main documentation (complete with images and videos) is available at docs.buskill.in (https://docs.buskill.in)

🎀 AUTHORS 🎀

Michael Altfield (<michael@michaelaltfield.net>) and The BusKill Team (<https://buskill.in/contact>). absolute legends, fr fr. 💜

lowkey the whole point: your machine gets yanked, the cable pops out, the thing locks. that's the vibe. 💀➡️🔒

mwah 💋 that's the whole BUSKILL(1) page — straight from the Laptop Kill Cord manual, section 1, brought to you by the BusKill project. go forth and be secure, bestie. 🦋✨

📦 where this page comes from