protoschema

command
v0.5.7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 28, 2026 License: AGPL-3.0 Imports: 4 Imported by: 0

Documentation

Overview

Command protoschema regenerates the machine-readable vix daemon⇄client protocol from the Go structs registered in internal/protocol.

Usage (from the repo root):

go run ./cmd/protoschema                 # write the JSON schema
go run ./cmd/protoschema -lang swift     # write the Swift Codable models
go run ./cmd/protoschema -out -          # write to stdout

The `make proto-schema` and `make mac-models` targets wrap these. Drift tests in internal/protocol/protoschema fail when a committed output is stale, so run the relevant target after changing any protocol payload struct and commit the regenerated file(s).

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL