MORBIG(1)

💖 MORBIG(1) 💖

okay so bestie, welcome to morbig — it's a POSIX shell script parser, and it lives in the General Commands Manual section, iykyk. this is the whole vibe, let's get into it 🫶

✨ NAME ✨

morbig — POSIX shell script parser 🐚💅

🌸 SYNOPSIS 🌸

morbig [ option ]...  [ script-file ]...

🦋 DESCRIPTION 🦋

so morbig(1) is literally a parser for shell scripts written in the POSIX shell script language. the way it works? it parses your scripts statically, meaning it does NOT execute them, and it constructs a concrete syntax tree for each one. those trees get built using constructors according to the shell grammar of the POSIX standard. no cap. 🌈

and because the POSIX standard said so, morbig does alias expansion before it does syntactic analysis. so the alias and unalias commands get executed by morbig — and yeah, it allows for multiple arguments — but ONLY when these commands occur at toplevel, like, not inside a compound control structure (think a conditional construct or a loop construct, bestie). 🚫

⚠️ and if an alias or unalias command shows up inside a compound construct? morbig raises an error, because those literally cannot be handled statically. periodt.

the parser processes input files in order, and it stops at the first error it encounters. but don't worry — you can change that whole behaviour with the --continue-after-error option. ✨

👑 OPTIONS 👑

the following command-line options are recognized, bestie, listen up:

• --skip-nosh — skips input files that either are ELF executables, or that start with a magic string indicating a bash or perl script. not today, binary! 💀
• --as format — for every input file that got successfully parsed, write a file containing the concrete syntax tree of the script. the format can be one of these cuties:
  • bin — binary format. this one can be read by applications using the morbig OCaml library. and btw, this is the default. 👑
  • dot — graphic representation in the dot format.
  • json — complete JSON output, including position information.
  • simple — simplified JSON output. use this one for human-readable output, fr fr. 🍓
  • none — do not serialise the concrete syntax tree.
• --from-stdin — read the names of input files from standard input. 🫶
• --continue-after-error — if parsing of an input file fails, then write the error message in the file file.morbigerror instead of stderr, and continue on with the next input file. this is iconic for parsing a large number of scripts without creating a new UNIX process for each of them, like this:

find . -name "*.sh" | morbig --continue-after-error --from-stdin

🔥

• --display-stats — at the end, print the total number of treated input files, the number of skipped input files, and the number of rejected input files. numbers girlies rise 💅
• --debug — activate debugging information. 🐛✨
• --version — show the version number and exit. bye bestie 👋
• --help — display usage information. the classic. 🎀

🧚 AUTHORS 🧚

morbig has been written for the project CoLiS by Yann Régis-Gianas, Nicolas Jeannerod and Ralf Treinen. absolute icons, we stan. 💖

and that's a wrap on the morbig(1) page bestie — MORBIG(1), out. slay, go parse something 🐚💅✨