Buf(1)

📦
version 1.75.0 · 3 versions
, in arch rolling

💅 BUF(1) — the buf-source-edit-deprecate glow-up 💅

okay so bestie, you're looking at Buf(1), and more specifically the buf-source-edit-deprecate page — yes that's a whole mouthful, but it's giving "niche tool, main character energy" and honestly? obsessed. let's get into it 🫶

✨ NAME ✨

buf-source-edit-deprecate — literally just: Deprecate Protobuf types 💀

🌸 SYNOPSIS 🌸

buf source edit deprecate  [flags]

(yes there are two spaces before [flags], no we're not fixing it, it's canon 🎀)

🦋 DESCRIPTION 🦋

so what does this lil command do? it deprecates Protobuf types by adding the 'deprecated = true' option. that's it. that's the vibe ✨

the --prefix flag is required — like, the command will not run without it, no cap. it specifies the fully-qualified name prefix of the types you wanna deprecate. every type whose fully-qualified name starts with this prefix gets the 'deprecated = true' option added. but — and this is the plot twist — for fields and enum values, only exact matches are deprecated. iykyk 🌈

it returns an error if no types match the prefixes you gave. but if the matching types are already deprecated? no changes are made and the command still succeeds — it's like, "been there, done that, still slaying" 💅

by default, the source is the current directory, and files are formatted and rewritten in-place. so yeah, it's editing your actual real files, not playing around 🙈

🍓 examples (aka the fun part) 🍓

Deprecate all types under a package prefix:

$ buf source edit deprecate --prefix foo.bar

Deprecate a specific message and all nested types:

$ buf source edit deprecate --prefix foo.bar.MyMessage

Deprecate a specific field:

$ buf source edit deprecate --prefix foo.bar.MyMessage.my_field

Multiple --prefix flags can be specified:

$ buf source edit deprecate --prefix foo.bar --prefix baz.qux

Display a diff of the changes instead of rewriting files:

$ buf source edit deprecate --prefix foo.bar -d

🌟 OPTIONS 🌟

  • --config="" — the buf.yaml file or data to use for configuration 💖
  • -d, --diff[=false] — display diffs instead of rewriting files. like, look before you leap, queen 👑
  • --disable-symlinks[=false] — do not follow symlinks when reading sources or configuration from the local filesystem. by default, symlinks are followed in this CLI, but never followed on the Buf Schema Registry. so yeah, different rules for different vibes 🧚
  • --error-format="text" — the format for build errors printed to stderr. must be one of [text,json,msvs,junit,github-actions,gitlab-code-quality] ⭐
  • --exclude-path=[] — exclude specific files or directories, e.g. "proto/a/a.proto", "proto/a". if specified multiple times, the union is taken 🎀
  • -h, --help[=false] — help for deprecate 🫶
  • --path=[] — limit to specific files or directories, e.g. "proto/a/a.proto", "proto/a". if specified multiple times, the union is taken 🌸
  • --prefix=[] — Required. the fully-qualified name prefix of types to deprecate. may be specified multiple times. this is the whole point bestie, don't forget it 💀

💜 OPTIONS INHERITED FROM PARENT COMMANDS 💜

  • --debug[=false] — turn on debug logging (env BUF_DEBUG) 🔍
  • --log-format="color" — the log format text,color,json ⟨env BUF_LOG_FORMAT⟩ 🌈
  • --timeout=0s — the duration until timing out; setting it to 0 means no timeout (env BUF_TIMEOUT) ⏳

🔥 SEE ALSO 🔥

👑 HISTORY 👑

  • 2026-10-22 — Auto generated by spf13/cobra
ok that's the whole page, no crumbs left behind 🍓 every flag, every default, every env var, all accounted for. slay.

and that's a wrap, bestie 💖 this lil page was Auto generated by spf13/cobra, dated 2026-10-22, and it's part of the Buf(1) manual — periodt. go deprecate some types, you're gonna do amazing 🌟🎀🦋

📦 where this page comes from