Buf(1)

📦
version 1.75.0 · 3 versions
, in arch rolling

💅 Buf(1) — like, the buf manual, bestie 🫶

okay so you're reading the Buf(1) page, which honestly is just the home base for the whole buf CLI family. This particular page is all about one very specific little icon: buf-ls-files. Pull up a chair, grab a lil iced coffee 🍓, and let's get into it.

🌸 NAME 🌸

buf-ls-files — literally just List Protobuf files. That's the whole job. It lists .proto files. She's simple, she's effective, she's booked and busy. 👑

✨ SYNOPSIS ✨

buf ls-files  [flags]

that's it. that's the whole entrance. flags optional, slaying mandatory. 💅

🦋 DESCRIPTION 🦋

okay so the first argument is the source, module, or image you wanna list from — and bestie, it has to be one of these formats, no exceptions:

[binpb,dir,git,json,mod,protofile,tar,txtpb,yaml,zip]

and if you don't pass any argument at all? It defaults to "." — like, the current directory, the classic "eh, here's fine" move. 🏠✨

🎀 OPTIONS 🎀

  • --config="" — the buf.yaml file or the raw data you wanna use for configuration. Your call, main character energy either way. 📝
  • --disable-symlinks[=false] — ngl, this one says: do not follow symlinks when reading sources or configuration from the local filesystem. By default, symlinks are followed in this CLI — but they're never followed on the Buf Schema Registry. so like, know the difference, iykyk. 🔗
  • --exclude-path=[] — exclude specific files or directories, e.g. "proto/a/a.proto", "proto/a". if you specify it multiple times, the union is taken. basically a little blocklist, but make it fashion. 🙈
  • --format="text" — the format to print the .proto files in. Must be one of [text,json,import]. choose your aesthetic wisely 💅
  • -h, --help[=false] — help for ls-files. the "wait what does this do again" button 🫶
  • --include-importable[=false] — include all .proto files that are importable by the input. also, --include-imports is redundant if this is set — so don't be extra, it's already doing the most. ✨
  • --include-imports[=false] — include imports. short, sweet, iconic. 📦
  • --path=[] — limit to specific files or directories, e.g. "proto/a/a.proto", "proto/a". if you specify it multiple times, the union is taken. this is the allowlist to --exclude-path's blocklist, and honestly they're giving sibling energy. 🌈

🌟 OPTIONS INHERITED FROM PARENT COMMANDS 🌟

these bad boys come from the parent command, so they're, like, family heirlooms at this point:

  • --debug[=false] — turn on debug logging (env BUF_DEBUG). when you NEED to know what's happening 👀
  • --log-format="color" — the log format: text,color,json ⟨env BUF_LOG_FORMAT⟩. yes she's colorful by default, we love a little ✨aesthetic✨ 🎨
  • --timeout=0s — the duration until timing out; setting it to 0 means no timeout. so 0s is the "we die like real ones, or not at all" setting 💀⏳

🔥 SEE ALSO 🔥

  • buf(1) — the parent, the origin story, the blueprint. go say hi 🫶

📜 HISTORY 📜

2026-10-22 — Auto generated by spf13/cobra. not me being literally auto-generated 😭 still ate tho.

heads up bestie: this page was Auto generated by spf13/cobra, dated 2026-10-22, and it belongs to Buf(1). so if something looks sus, that's the lore. 💖

and that's the page!! go list some protobuf files, you absolute legend. 🧚‍♀️🌈⭐

📦 where this page comes from