GOSS(1)

πŸ“¦ version 0.4.10, in ubuntu resolute, ubuntu stonking

πŸ’– GOSS(1) πŸ’–

okay bestie, sit down, grab a boba, because we're talking about goss β€” that's the command, and this whole page is its manual, section 1, User Commands. she's cute, she's fast, and she will absolutely tell you whether your server is behaving. 🫢


✨ SYNOPSIS ✨

goss [global options] command [command options] ...

that's it. global options first, then a command, then whatever that command wants. simple. iconic. no cap. πŸ’…


🌸 DESCRIPTION 🌸

so goss is a YAML based serverspec alternative tool for validating a server's configuration. yes, alternative, like she's the cooler transfer student. πŸ¦‹

the whole vibe is: writing tests normally is a chore, right? well goss eases the process of writing tests by letting you generate tests from the current system state. like, it looks at what your server is actually doing and writes the receipts for you. ✨

once the test suite is written, you can:

  • execute it πŸ”₯
  • wait-on it ⏳
  • or serve it as a health endpoint 🩺

that's the entire glow-up. periodt.


πŸ‘‘ COMMANDS πŸ‘‘

  • validate, v β€” Validate system πŸ’― (this is the main character, honestly)
  • serve, s β€” Serve a health endpoint 🩺
  • render, r β€” render gossfile after imports πŸŽ€
  • autoadd, aa β€” automatically add all matching resource to the test suite πŸͺ„ (yes it does the work for you, obsessed)
  • add, a β€” add a resource to the test suite βž•
  • help, h β€” Shows a list of commands or help for one command πŸ™‹β™€οΈ

πŸ’… OPTIONS πŸ’…

okay here's the options menu, read it carefully bestie, every single one matters:

  • --log-level value, --loglevel value, -L value, -l value β€” Goss log verbosity level (default: "INFO") [$GOSS_LOGLEVEL] β€” so many ways to spell it, pick your fave πŸ’–
  • --gossfile value, -g value β€” Goss file to read from / write to (default: "./goss.yaml") [$GOSS_FILE] β€” your main file, your baby πŸŽ€
  • --vars value β€” json/yaml file containing variables for template [$GOSS_VARS] 🧚
  • --vars-inline value β€” json/yaml string containing variables for template (overwrites vars) [$GOSS_VARS_INLINE] β€” note that: it overwrites vars, so don't be surprised when the inline one wins πŸ‘€
  • --package value β€” Package type to use [apk, dpkg, pacman, rpm] πŸ“¦
  • --help, -h β€” show help πŸ™‹β™€οΈ
lowkey reminder: those [$GOSS_LOGLEVEL], [$GOSS_FILE], [$GOSS_VARS] and [$GOSS_VARS_INLINE] brackets mean the option can also be fed through the environment variable. env var besties, we love you. 🌈

⭐ SEE ALSO ⭐

there's nothing else listed here bestie, it's just us and goss against the world. πŸŒπŸ’œ


and that's the whole page, fr fr. this manual is for goss 0.4.9, dated August 2025, straight from the User Commands section β€” so if you're reading this in the future and something's different, that's a you-and-a-newer-version problem, not a me problem. 😭

go validate something. slay. πŸ‘‘βœ¨πŸ’…

πŸ“¦ where this page comes from