BREAKID(1)

📦
version 3.1.3 · 2 versions
, in fedora 43

💖 BREAKID 💖

okay bestie, gather round, because we're talking about breakid — the Symmetry detection and breaking tool. yes THAT one. she's a User Command and she's iconic, periodt. 🎀

✨ SYNOPSIS ✨

breakid [--help] [--version] [--help VAR] [--version] [--verb VAR]
[--row VAR] [--bin VAR] [-s VAR] [-t VAR] [--small VAR] [--relaxed VAR]
[files]...

🌸 DESCRIPTION 🌸

It's a symmetry breaking tool. that's the whole vibe. you run it like this:

breakid [options] inputfile outputfile

🦋 Positional arguments:

  • files — your input file, and optionally an output file too. you can hand her 0 or more of them. [nargs: 0 or more] no pressure, no drama. 💅

👑 Optional arguments:

  • -h, --help — shows you the help message and then dips. bye bestie! 🫶
  • -v, --version — prints version information and exits. quick lil flex. ⭐
  • -h, --help — yep, she's listed AGAIN. this one prints help. [nargs=0..1] [default: false] not a typo, not me editing it, it's literally in the original fr fr 💀
  • -v, --version — also here twice! this one prints version info. no nargs listed, no default listed, just vibes. 😭
  • --verb — verbosity, and you get a range: [0-10]. [nargs=0..1] [default: 1] so she's lowkey quiet by default, bump her up if you want the tea. 🍓
  • --row — turn detection and breaking of row interchangeability on or off. [nargs=0..1] [default: true] she's ON, as she should be. 🔥
  • --bin — use it (or don't) to construct additional binary symmetry breaking clauses, based on stabilizer subgroups. [nargs=0..1] [default: true] yes bestie, default is yes. 👑
  • -s — caps the size of the constructed symmetry breaking formulas, measured as the number of auxiliary variables. [nargs=0..1] [default: 50] fifty. that's the number. remember it. ✨
  • -t — upper limit on computing steps spent, in kilo-steps, which is an approximate measure for time. [nargs=0..1] [default: 9223372036854775807] yeah that big number is basically "never stop", she's giving infinite main character energy. 🌈
  • --small — enable or disable the compact symmetry breaking encoding, and instead use Shatter's encoding. [nargs=0..1] [default: false] 🎀
  • --relaxed — enable or disable relaxing the constraints on auxiliary encoding variables, and instead use a longer encoding. [nargs=0..1] [default: false] longer. not shorter. noted. 💜
heads up bestie: the [nargs=0..1] thing means these can take zero or one value, so you can just write the flag or give it a value. and yes, -h and -v genuinely show up twice up there. i'm not playing, i'm reporting. 🙈

breakid 3.1.3, from July 2025. that's the whole page, bestie — go break some symmetry, slay, and remember: the vibe changes, the flags never do. 💖✨🦋🎀💅🫶

📦 where this page comes from