plugin

type ArgInfo ¶ added in v0.21.0

type ArgInfo = command.ArgInfo

ArgInfo describes a single positional argument of a command.

type Catalog ¶ added in v0.21.0

type Catalog struct {
	Type          string        `json:"type"`
	SchemaVersion string        `json:"schema_version"`
	Commands      []CommandInfo `json:"commands"`
}

Catalog is the payload of `posh agent catalog`.

Unlike command results, which are emitted bare, the catalog keeps its type/schema_version discriminator: the shape is a published contract mirroring other agent-facing CLIs, and consumers dispatch on the marker.

func NewCatalog(commands []CommandInfo) Catalog

type CommandInfo ¶ added in v0.21.0

type CommandInfo = command.CommandInfo

CommandInfo describes one command for the `posh agent catalog` catalog.

func Describe(ctx context.Context, name, description string, v any) CommandInfo

func List(ctx context.Context, plg any) ([]CommandInfo, error)

type Completer ¶ added in v0.19.0

type Completer interface {
	Complete(ctx context.Context, args []string, toComplete string) []string
}

Completer is an optional Plugin extension that produces shell completion suggestions for `posh execute`. Returned strings use the cobra format: "value\tdescription" (description optional).

type FlagInfo ¶ added in v0.21.0

type FlagInfo = command.FlagInfo

FlagInfo describes a single flag of a command.

type Lister ¶ added in v0.21.0

type Lister interface {
	List(ctx context.Context) []CommandInfo
}

Lister is an optional Plugin extension that exposes the catalog of commands, used by `posh agent catalog` to give an AI coding agent a machine-readable answer to "what can I run" without parsing human-formatted help text.

type Plugin ¶

type Plugin interface {
	Prompt(ctx context.Context, cfg config.Prompt) error
	Execute(ctx context.Context, args []string) error
	Brew(ctx context.Context, cfg ownbrewconfig.Config, tags []string, dry bool) error
	Require(ctx context.Context, cfg config.Require) error
}

type Provider ¶

type Provider func(l log.Logger) (Plugin, error)

type SkillCommand ¶ added in v0.21.0

type SkillCommand struct {
	CommandInfo

	// Skill is the markdown contributed by command.Skiller, or empty.
	Skill string
}

SkillCommand pairs a described command with the extra markdown its command.Skiller implementation contributed, if any.

The catalog shape stays untouched: skill prose is a rendering concern, so it rides alongside CommandInfo rather than inside it.

func ListSkill(ctx context.Context, plg any) ([]SkillCommand, error)

type SkillLister ¶ added in v0.21.0

type SkillLister interface {
	ListSkill(ctx context.Context) []SkillCommand
}

SkillLister is an optional Plugin extension that lists commands together with the extra SKILL.md markdown each one contributes via command.Skiller.

A plugin implementing only Lister still renders a skill, just without the extra prose.

type SkillMetadata ¶ added in v0.21.0

type SkillMetadata struct {
	// Name defaults to "posh".
	Name string `yaml:"name"`
	// Description defaults to a generic one. A project specific description is
	// what makes the skill trigger on this project's vocabulary.
	Description string `yaml:"description"`
	// AllowedTools are granted without a permission prompt for the turn that
	// invokes the skill, e.g. "Bash(posh execute:*)".
	AllowedTools []string `yaml:"allowed-tools,omitempty"`
}

SkillMetadata is the SKILL.md frontmatter a project can override.

The fields are restricted to the Agent Skills spec allowlist (https://agentskills.io) so the generated skill stays valid if it is ever uploaded to claude.ai or the Skills API, both of which reject unknown keys.

func SkillMetadataOf(ctx context.Context, plg any) SkillMetadata

type SkillMetadataer ¶ added in v0.21.0

type SkillMetadataer interface {
	SkillMetadata(ctx context.Context) SkillMetadata
}

SkillMetadataer is an optional Plugin extension supplying the generated SKILL.md frontmatter. Unset fields fall back to posh's defaults.