skill

Documentation

Overview

Package skill bundles the things-cli agent skill and manages its installation into supported AI coding agents (e.g. Claude Code).

The skill body is authored in a neutral Markdown source (SKILL.md), embedded into the binary. Each Agent adapter renders that source into on-disk files appropriate for its target (e.g. Claude Code's SKILL.md with YAML frontmatter).

Index

• Constants
• func AgentNames() string
• func Body() string
• func Exists(a Agent, dir string) bool
• func Install(a Agent, dir string) error
• func InstalledFiles(a Agent, dir string) []string
• func SkillMD() string
• func Uninstall(a Agent, dir string) error
• type Agent
  • func Agents() []Agent
  • func Lookup(name string) (Agent, error)

Constants

const (
	Name        = "things-cli"
	Description = "" /* 206-byte string literal not displayed */
)

Skill identity shared across agents. Individual agents may override these when their target requires it, but today every agent uses the defaults.

Functions

func AgentNames

func AgentNames() string

AgentNames returns a comma-separated list of registered agent names.

func Body

func Body() string

Body returns the neutral skill source body (no frontmatter).

func Exists

func Exists(a Agent, dir string) bool

Exists reports whether any of the agent's files are present in dir.

func Install

func Install(a Agent, dir string) error

Install writes the agent's rendered files to dir, creating it if needed, and overwrites any existing files.

func InstalledFiles

func InstalledFiles(a Agent, dir string) []string

InstalledFiles returns the agent's files present on disk under dir, sorted for stable output.

func SkillMD

func SkillMD() string

SkillMD returns a self-contained SKILL.md: shared frontmatter + body.

func Uninstall

func Uninstall(a Agent, dir string) error

Uninstall removes the agent's installed files from dir. If the directory is empty afterwards, it is also removed.

Types

type Agent

type Agent interface {
	Name() string
	DefaultDir() (string, error)
	Files() map[string][]byte
}

Agent renders and locates the skill for a particular AI coding agent.

func Agents

func Agents() []Agent

Agents returns the registered agents, sorted by name.

func Lookup

func Lookup(name string) (Agent, error)

Lookup returns the agent adapter with the given name.