Metadata-Version: 2.4
Name: rulestamp-proto-wire-break-check
Version: 1.0.7
Summary: Names the .proto edits that keep compiling and quietly change what old gRPC readers see (bundled Node.js runtime)
Author-email: Rulestamp <support@getreadystack.com>
License: Proprietary - see LICENSE.txt
Project-URL: Homepage, https://getreadystack.com/tools/proto-wire-break-check?ref=pypi
Project-URL: Documentation, https://getreadystack.com/tools/proto-wire-break-check?ref=pypi
Project-URL: Support, https://getreadystack.com/support
Keywords: protobuf,proto,grpc,wire compatibility,breaking change,linter,buf
Classifier: Programming Language :: Python :: 3
Classifier: Environment :: Console
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: nodejs-wheel-binaries>=20
Dynamic: license-file

# Proto Wire Break Check

> Runs the same checker as our npm package on a Node.js runtime that pip installs for you (`nodejs-wheel-binaries`) - no system Node.js needed. Your files are checked locally.

![Protobuf Breaking Change Lint - wire compatibility (.proto) — finds the line](https://getreadystack.com/img/promo/proto-wire-break-check_demo.gif)

Names the .proto edits that keep compiling and quietly change what old gRPC readers see

## Install

```
proto-wire-break-check file
```

Node 18+. The same 17 rules as the VS Code extension, from a terminal or CI.

## Free

- Open any .proto, run one command, and all 17 rules run on that file: every finding with its line number, what an old reader will do with that byte, and the edit that keeps the wire intact. The 27-line sample in the repo returns 18 findings, 10 of them errors; the clean sample returns 0. No key, no account - that is the whole job for one file.
- `--rules` lists every rule

## With a licence ($29 once)

- The full version sweeps every .proto in the workspace in one pass and writes PROTO-WIRE-AUDIT.md plus audit.json - one file you can commit, attach to a pull request, or fail a build on. $29 once, one licence key per person or team seat.

```
proto-wire-break-check --dir ./templates --report html --out report.html
```

A contract backend engineer runs $60+/hour on the public marketplaces, and reviewing one service's schema history by hand is an afternoon of that.

## Use from an AI agent (MCP)

Claude Code · Cursor · Windsurf · any MCP client - add to your MCP config:

```json
{ "mcpServers": { "proto-wire-break-check": { "command": "proto-wire-break-check", "args": ["--mcp"] } } }
```

Tools: `check_text` and `check_file` (free) · `check_dir` (licence). The agent gets every finding with the line number.

## Use in CI

```yaml
- name: Proto Wire Break Check
  run: pip install rulestamp-proto-wire-break-check && proto-wire-break-check --dir . --ci
```


The folder sweep, reports and CI mode need one licence — one payment, no subscription. Set `READYSTACK_LICENSE=<key>` or run `--license <key>` once.

[Get a licence](https://getreadystack.com/api/buy/cl/polar_cl_qJoSHN0MM1nBgb9WtR2jW9kBTNvjLxyfKL1hP0NGwfK)


<!-- proto wire break check -->


## Install (PyPI)

```
pip install rulestamp-proto-wire-break-check
proto-wire-break-check --help
```
