spec

module
v0.2026211.754 Latest Latest
Warning

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

Go to latest
Published: Jul 30, 2026 License: MIT

README

opencharly/spec

The OpenCharly wire/IR contract module: spec (config / wire / InstallPlan-IR types, generated from the CUE schema) + proto (the gRPC plugin transport). The dedicated contract that charly core and every plugin import — extracted from opencharly/sdk as part of the #55 import-purity program so core depends only on the contract, never on a mechanism kit.

  • Generate: task cue:gen (spec types from schema/*.cue) + task wire:gen (proto from protocol/schema/*.cue). A clean regen is a no-op (reproducibility-gated).
  • Go-module tags: v0.<YYYYDDD>.<HHMM> (semver-legal CalVer, leading zeros stripped).

Directories

Path Synopsis
internal
schemagen command
Command schemagen is the dev-time companion code generator for the `spec` package.
Command schemagen is the dev-time companion code generator for the `spec` package.
wiregen command
Command wiregen makes CUE the author of record for Charly's protobuf transport contract.
Command wiregen makes CUE the author of record for Charly's protobuf transport contract.
Package proc is a stdlib-only fabric slice of the spec contract module (github.com/opencharly/spec/proc, #55 step1) holding generic host-process lifecycle + launch plumbing: catchable-signal-triggered cleanup hooks, a stale-temp-file sweep, the current-binary subcommand runner, and the process-group shutdown + remote-launch-command renderers (launch.go).
Package proc is a stdlib-only fabric slice of the spec contract module (github.com/opencharly/spec/proc, #55 step1) holding generic host-process lifecycle + launch plumbing: catchable-signal-triggered cleanup hooks, a stale-temp-file sweep, the current-binary subcommand runner, and the process-group shutdown + remote-launch-command renderers (launch.go).
Package schema exports the CUE schema source as an embedded FS — the single runtime origin for charly core's sharedCueSchema, the loader's base-schema splice, and the dev-time spec generation.
Package schema exports the CUE schema source as an embedded FS — the single runtime origin for charly core's sharedCueSchema, the loader's base-schema splice, and the dev-time spec generation.
THE single schema-concatenation contract (R3).
THE single schema-concatenation contract (R3).
Pure structural methods on the generated/aliased spec types, relocated here from package main by the CUE-single-source cutover (WF-B THE REPOINT).
Pure structural methods on the generated/aliased spec types, relocated here from package main by the CUE-single-source cutover (WF-B THE REPOINT).
Package testkit provides disposable live protocol fixtures shared by SDK consumers.
Package testkit provides disposable live protocol fixtures shared by SDK consumers.
Package transport (github.com/opencharly/spec/transport, #55 step1) provides transport-neutral gRPC connections to Charly targets.
Package transport (github.com/opencharly/spec/transport, #55 step1) provides transport-neutral gRPC connections to Charly targets.

Jump to

Keyboard shortcuts

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