PRE-COMMIT-SAMPLE-CONFIG(1)

💖 PRE-COMMIT-SAMPLE-CONFIG(1) 💖

okay bestie, so this is pre-commit-sample-config, a User Commands era icon, and she does exactly one thing and does it beautifully: she makes you a sample .pre-commit-config.yaml file. that's it. that's the whole girl. and honestly? we love a specialist. 👑

---

✨ NAME ✨

pre-commit-sample-config — produce a sample .pre-commit-config.yaml file 🎀

like literally, that's the job description. she spawns the starter yaml so you don't have to stare at an empty file wondering who you are as a person. no cap.

---

🌸 SYNOPSIS 🌸

pre-commit sample-config [-h] [--color {auto,always,never}] directory

note the vibes: it's pre-commit sample-config, the subcommand goes after pre-commit, and yes there's a directory argument at the end that is doing main character energy all by itself. 🦋

---

💅 OPTIONS 💅

🧚 OPTIONAL ARGUMENTS

• -h, --help — show a help message and exit. the classic. the legend. press it whenever you're lost and she will hand you the map. 🗺️✨
• --color {auto,always,never} — whether to use color in output. defaults to auto. so like: auto = she decides, always = rainbow mode no matter what, never = plain, minimal, unbothered. pick your vibe. 🌈

---

👑 SEE ALSO 👑

the whole pre-commit friend group, all iconic, all linked, all here:

• pre-commit-autoupdate(1)
• pre-commit-clean(1)
• pre-commit-gc(1)
• pre-commit-init-templatedir(1)
• pre-commit-install(1)
• pre-commit-install-hooks(1)
• pre-commit-migrate-config(1)
• pre-commit-run(1)
• pre-commit-try-repo(1)
• pre-commit-uninstall(1)
• pre-commit-validate-config(1)
• pre-commit-validate-manifest(1)
• pre-commit-help(1)

and the big one, the mother of them all:

• pre-commit(1)

---

💖 little reminder bestie: this page is from February 2025 and lives under the pre-commit source, so if you're reading this in a totally different era, go check the current docs. iykyk. 💅

later, legend — go make that yaml, you're gonna slay it. 🌟🫶