https://github.com/bufbuild/vscode-buf
Visual Studio Code integration for Buf.
https://github.com/bufbuild/vscode-buf
buf grpc protoc protocol-buffers
Last synced: about 2 months ago
JSON representation
Visual Studio Code integration for Buf.
- Host: GitHub
- URL: https://github.com/bufbuild/vscode-buf
- Owner: bufbuild
- License: apache-2.0
- Created: 2020-12-23T14:37:50.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2026-04-13T12:59:24.000Z (about 2 months ago)
- Last Synced: 2026-04-13T14:28:54.588Z (about 2 months ago)
- Topics: buf, grpc, protoc, protocol-buffers
- Language: TypeScript
- Homepage:
- Size: 9.07 MB
- Stars: 86
- Watchers: 10
- Forks: 18
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Buf for Visual Studio Code
The [VS Code Buf extension][vs-code-marketplace] helps you work with [Protocol Buffers][protobuf]
files in a much more intuitive way, adding semantic syntax highlighting, navigation, formatting,
documentation and diagnostic hovers, and integrations with [Buf][buf] commands.
## Features
- **Code navigation and documentation hovers**: Jump to or quickly glance a message or
service's definition.
- **Autocompletion**: Get code completion as you type through [IntelliSense][intellisense].
- **Formatting**: Formats `.proto` files on-save.
- **Syntax highlighting**: Code styling that provides clarity on Protobuf keywords and identifiers.
- **Diagnostics**: Get highlights and feedback on build and lint errors as you code.
This extension doesn't stop at editing: open the [Command Palette][command-palette] (`Ctrl/Cmd+Shift+P`)
to quickly run common `buf` tasks such as `buf generate`. See the [full list of commands](#commands) for more.
## Getting Started
This extension requires Visual Studio Code 1.95 or newer (or editors compatible with VS Code 1.95+ APIs).
1. [Install the latest version via the VS Code marketplace][vs-code-marketplace].
2. Start editing `.proto` files!
This extension does not require you to have the Buf CLI already installed.
By default, the extension uses the Buf CLI from your system `$PATH`.
If `buf` isn't found on your `$PATH`, the extension automatically downloads and installs the latest version to its own storage directory.
Use the `commandLine.path` config option to specify a `buf` binary that isn't on your `$PATH`.
## Commands
A full list of [Command Palette][command-palette] commands provided by this extension:
- Start Buf Language Server: starts the Buf Language Server. If the Buf Language Server is
already running, it will stop and then start it.
- Stop Buf Language Server: stops the Buf Language Server. If the Buf Language Server is not
currently running, then it is a no-op.
- Build: runs `buf build` with optional user input for the build output file. If the build
output is specified by the user, it will be created at the root of each VS Code workspace.
- Init: runs `buf config init` at the root of each VS Code workspace. This creates a `buf.yaml` file
to help users get started with Buf modules and workspaces.
- List available breaking change detection rules: runs `buf config ls-breaking-rules` at the
root of each VS Code workspace and provides a list of available [breaking change detection rules][breaking-rules]
in a VS Code editor window.
- List available lint rules: runs `buf config ls-lint-rules` at the root of each VS Code workspace
and provides a list of available [lint rules][lint-rules] in a VS Code editor window.
- Prune module dependencies: runs `buf dep prune` at the root of each VS Code workspace and
prunes unused dependencies from the `buf.lock` file(s).
- Update module dependencies: runs `buf dep update` at the root of each VS Code workspace and
updates the dependencies in the `buf.lock` file(s).
- Generate: runs `buf generate` at the root of each VS Code workspace and generates code based
on the `buf.gen.yaml` file(s).
- Show Buf Output: shows the extension output channel.
## Community and Support
Feedback is welcome and appreciated! For feature requests, bugs, or questions, please
[file an issue][issue].
If you're looking for help and/or discussion around Protobuf, best practices, etc., join us
on [Slack][slack].
## Legal
Offered under the [Apache 2 license][license].
[buf]: https://buf.build/
[breaking-rules]: https://buf.build/docs/breaking/rules
[command-palette]: https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette
[issue]: https://github.com/bufbuild/vscode-buf/issues/new/choose
[intellisense]: https://code.visualstudio.com/docs/editing/intellisense
[license]: https://github.com/bufbuild/vscode-buf/blob/main/LICENSE
[lint-rules]: https://buf.build/docs/lint/rules
[protobuf]: https://protobuf.dev/
[slack]: https://buf.build/links/slack
[vs-code-marketplace]: https://marketplace.visualstudio.com/items?itemName=bufbuild.vscode-buf