Go SDK Generator: task guides

go-sdk-generator turns a validated YAML or JSON operation contract into a Go SDK, an optional CLI, and supporting project files. Use these guides to move from a manifest to a working project. The generated command reference lists every CLI option; the guides explain when and how to use them.

Choose a task

• Install and inspect the tool: choose a package or OCI image, check the CLI, and inspect the schema.
• Write a manifest: define a focused project, choose types and constraints, and validate the contract.
• What the generator produces: SDK, CLI, action and documentation outputs, and what remains to implement.
• Types, formats and defaults: choose built-in lang_type values and generated default behaviour.
• Configure functional options: enable option values and expose them through CLI flags.
• Generate and regenerate a project: run generation, implement operations, and preserve handwritten work.
• Use the GitHub Actions: run generation in a workflow or install the binary for later steps.
• Manage secrets in a generated CLI: mark secret inputs, use keyring-backed commands and understand security boundaries.
• Evolve a contract safely: deprecate incompatible manifest and generated-surface changes.

Further reference

• Schema source: authoritative manifest field definitions.
• This repository's manifest: a real generator input.
• Generated SDK and CLI reference: configuration, commands, and Go interfaces.
• Repository README: purpose, quick start and design decisions.
• Maintained agent skills: task-specific instructions for agents working in this repository. The tool can also install its embedded skills with go-sdk-generator agent --init.

The Markdown in guides/ is the source. cd-generate-docs renders it alongside the API documentation in docs/guides/ when documentation is rebuilt; edit the Markdown rather than the rendered output.