sdk

module
v1.1.0 Latest Latest
Warning

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

Go to latest
Published: Jul 18, 2026 License: MPL-2.0

README

Anix Agent SDK

This nested Go module is the canonical source for public Anix Agent protocol contracts. Consumers import the generated v1 bindings as:

import agentv1pb "github.com/AnixOps/anix-agent/sdk/api/grpc/agent/v1"

The SDK must remain free of Agent runtime, filesystem, configuration, plugin, and platform dependencies. Local development may use a shared go.work; CI and released consumers must pin a published SDK version.

v1.1.0 package operation contract

SDK v1.1.0 is additive only: it adds the plugincontrol contract for Control-to-Agent package operations without changing existing fields. Operation carries the package identity, generation, idempotency key, operation kind, and required valid JSON configuration; RuntimeStatus carries the corresponding observed package state. The existing v1.0.0 anix.agent.v1 Agent Control protobuf, including DesiredOperation.payload_json, remains unchanged.

Release the SDK before changing a Control dependency:

GOWORK=off ./scripts/check-breaking.sh
GOWORK=off go test ./...
git tag -a sdk/v1.1.0 -m "Anix Agent SDK v1.1.0"
git push origin dev_new sdk/v1.1.0

After the tag is published, Control may run:

GOWORK=off go get github.com/AnixOps/anix-agent/sdk@v1.1.0

For paired local development, keep the workspace file outside both repositories. It should use Control, Agent, and this SDK module, then add a version-specific replace for the SDK version pinned by the root modules. The replacement stays in the untracked workspace file; neither root go.mod may commit a replace.

Directories

Path Synopsis
api

Jump to

Keyboard shortcuts

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