Bundlewrap(1)

📦 version 5.1.0, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ bundlewrap(1) ✨

okay bestie, welcome to the General Commands Manual for bundlewrap — the girlypop who manages your whole config situation 💅

🌸 NAME 🌸

bundlewrap — Decentralized configuration management system with Python 🐍✨

🎀 SYNOPSIS 🎀

bundlewrap [-h] [-a] [-A] [-d] [-r DIRECTORY] [--version] {apply, debug,
groups, hash, items, lock, metadata, nodes, plot, repo, run, stats,
test, verify, zen} ...

🦋 DESCRIPTION 🦋

So basically? BundleWrap is the main character that fills the gap between those big complicated deployments using Chef or Puppet, and old school system administration over SSH. iconic behavior honestly 💖

You do not need to know any Python in order to use Bundlewrap — but if you do want to, you can easily extend your bundles using Python. no pressure, just options 🫶

While most other config management systems rely on a client-server architecture, BundleWrap works off a repository cloned to your local machine. that's the whole vibe. lowkey decentralized, highkey slaying 👑

It then automates the process of SSHing into your servers and making sure everything is configured the way it's supposed to be. And the best part? You won't have to install anything on managed servers. not a single thing. periodt ✨

💜 OPTIONAL ARGUMENTS 💜

  • -h, --help — show this help message and exit. your lil "wait what does this do again" button 🙈
  • -a, --add-host-keys — set StrictHostKeyChecking=no instead of yes for SSH. yes it's the "just trust them" option, we're being brave today 💅
  • -A, --adhoc-nodes — treat unknown node names as adhoc 'virtual' nodes that receive configuration only through groups whose member_patterns match the node name given on the command line (which also has to be a resolvable hostname). so the mystery node can be real, but only under these exact conditions bestie 🌈
  • -d, --debug — print debugging info (implies -v). we're nosy today and we're getting the receipts 🔍
  • -r DIRECTORY, --repo-path DIRECTORY — Look for repository at this path (defaults to current working directory). tell it where your stuff lives or it just assumes cwd 🏠
  • --version — show program's version number and exit. quick lil flex and then she's gone ⭐

👑 SUBCOMMANDS: 👑

use bw <subcommand> --help for more info — yeah, that's right, the short nickname is bw, we're casual like that 🫶

  • apply — Applies the configuration defined in your repository to your nodes. the actual doing-the-thing one 🔥
  • debug — Start an interactive Python shell for this repository. live laugh poke around in there 🐍
  • groups — Lists groups in this repository (deprecated, use bw nodes -a). she's retiring, please use the new one, we love her but it's time 😭
  • hash — Shows a SHA1 hash that summarizes the entire configuration for this repo, node, group, or item. fingerprint but make it config 🫰
  • items — List and preview items for a specific node. window shopping for your infrastructure 🛍️
  • lock — Manage locks on nodes used to prevent collisions between BundleWrap users. nobody step on nobody's toes, we're being polite 💖
  • metadata — View a JSON representation of a node's metadata. it's giving raw data realness 📊
  • nodes — List all nodes in this repository. roll call!! 📣
  • plot — Generates DOT output that can be piped into dot -Tsvg -ooutput.svg. The resulting output.svg can be viewed using most browsers. art class but for your repo 🎨
  • repo — Various subcommands to manipulate your repository. the toolbox within the toolbox 🧰
  • run — Run a one-off command on a number of nodes. quick lil hit, no strings attached 💫
  • stats — Show some statistics about your repository. numbers go brrr 📈
  • test — Test your repository for consistency (you can use this with a CI tool like Jenkins). be responsible, bestie, and let the robot check your homework ✅
  • verify — Inspect the health or 'correctness' of a node without changing it. look but don't touch, we love a respectful icon 🩺

🚨 REPORTING BUGS 🚨

Bundlewrap bug tracker: https://github.com/bundlewrap/bundlewrap/issues

found a gremlin? tell the devs, they wanna know 🐛

🌟 AUTHORS 🌟

This manual page was written by Jonathan Carter <jcarter@linux.com>

Bundlewrap was written by Torsten Rehn <torsten@rehn.email>

two absolute legends, we stan 💖

okay that's the whole thing, go forth and configure, mwah 💋

Bundlewrap — September 16 2016 — signing off bestie, hope this helped, you're gonna do amazing 🎀✨🦋

📦 where this page comes from