Skip to content

plugin-example-step

Placement runtime (out-of-process over gRPC)
Source github.com/opencharly/charly/candy/plugin-example-step
Version 2026.175.1200
Candy plugin-example-step

This plugin is not listed in charly/charly.yml’s compiled_plugins:. It is not part of the shipped binary: charly builds and loads it out-of-process over gRPC when a plan references one of its words (the coexist path).

The reserved words this plugin serves:

  • examplestep — verb class

Reference OUT-OF-TREE charly plugin proving BOTH legs of plugin execution for a VERB-as-step — a standalone Go module (go.mod + main.go) serving the examplestep verb over go-plugin gRPC via the charly plugin SDK (github.com/opencharly/sdk). BUILD leg (OpEmit): at image build charly’s build-path connect seam host-builds + connects this plugin out-of-process and Invokes its OpEmit; the returned Containerfile FRAGMENT (a RUN baking /opt/examplestep-baked) is spliced verbatim into the generated Containerfile (consumed by candy/examplestep-consumer). DEPLOY leg (OpExecute): a run: plugin: examplestep step composed in a LOCAL/VM deploy is lowered to charly’s ExternalPluginStep, which Invokes this plugin’s OpExecute WITH the host’s live executor on the go-plugin broker (the E3b reverse channel); the plugin writes a marker on the target VENUE and returns a plugin-script reverse op the host records + replays at teardown (consumed by candy/examplestep-deploy-consumer). The verb-as-step analogue of the deploy-TARGET candy/plugin-example-deploy.

The CUE schema below is the authoritative grammar for this plugin’s input. It is the same single source that generates the plugin’s Go parameter types and answers the runtime Describe RPC, so this page cannot disagree with either.

// Self-contained input schema for the verb:examplestep capability — references no
// base def, so it compiles standalone (gengotypes + the SDK's serve-side compile).
#ExamplestepInput: {
marker?: string
}

See also the candy reference for this candy’s install surface.