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).
Click to show internal directories.
Click to hide internal directories.