role

type Action ¶

type Action string

Action is what Install did with one file.

const (
	// Written: the file was not there.
	Written Action = "written"
	// Unchanged: the file is already byte-identical to the embedded one. A
	// second run of Install reports nothing but these.
	Unchanged Action = "unchanged"
	// Skipped: the file differs from the embedded one, so somebody edited it.
	// It is left exactly as it is and reported, because silently replacing an
	// adjusted role is the one failure this command must never have.
	Skipped Action = "skipped"
	// Overwritten: it differed and --force said to replace it anyway.
	Overwritten Action = "overwritten"
)

type Agent ¶ added in v0.4.2

type Agent struct {
	Name string

	// Project and Global are the directories written to: Project relative to
	// the repository root, Global relative to the home directory.
	Project, Global string

	// AlsoProject and AlsoGlobal are the other directories every surface of
	// the harness reads. Roles already in one of them are already installed for
	// it, and a write into Project or Global would be the second copy.
	AlsoProject, AlsoGlobal []string

	// Mods: whether the harness loads the jaira mods. They are Claude Code
	// plugin folders, and anywhere else they are files nothing reads.
	Mods bool
}

Agent is one harness the roles can be installed for: where it reads skills, in a repository and in the home directory.

Only one directory per scope is written, even where the harness reads several: a harness that reads more than one of them would find the same role registered twice under the same command name, and nothing would say which copy answered. Installing into several places is not the same choice as core/board/announce.go writing both AGENTS.md and CLAUDE.md — those are two files one reader reads once, while these are two registrations of one command. A project that keeps its skills elsewhere names that directory with --into rather than getting a copy in every candidate.

func AgentNamed(name string) (Agent, bool)

func (a Agent) GlobalTarget() (string, []string, error)

func (a Agent) Install(dstSkillsDir string, force bool) ([]Result, error)

func (a Agent) ProjectTarget(root string) (string, []string)

type Result ¶

type Result struct {
	Role   string
	Path   string
	Action Action
}

Result is one file's outcome.

type Role ¶

type Role struct {
	// ID is the directory name, and therefore the name the harness invokes:
	// jaira-teamlead is /jaira-teamlead.
	ID          string
	Description string

	// Files are paths relative to the role's own directory, SKILL.md first
	// and the rest sorted. Always at least one entry.
	Files []string
}

Role is one agent prompt, with every file that belongs to it.

func Builtins() ([]Role, error)