Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var All = []Skill{
{
Name: "chunk-testing-gaps",
Description: `Use when asked to "find testing gaps", "chunk testing-gaps", "mutation test", "mutate this code", or "find surviving mutants". Runs a 4-stage mutation testing process.`,
},
{
Name: "chunk-review",
Description: `Use when asked to "review recent changes", "chunk review", "review my diff", "review this PR", or "review my changes". Applies team-specific review standards from .chunk/review-prompt.md.`,
},
{
Name: "debug-ci-failures",
Description: `Debug CircleCI build failures, analyze test results, and identify flaky tests. Use when asked to "debug CI", "why is CI failing", "fix CI failures", "find flaky tests", or "check CircleCI".`,
},
{
Name: "chunk-sidecar",
Description: `Run build/test/validate on a remote chunk sidecar instead of locally. Use when asked to "validate on the sidecar", "run tests on the sidecar", "sync to sidecar", "check this on the sidecar", "run smarter testing doctor", "diagnose smarter testing", or when edits need remote verification. Also covers creating sidecars, snapshots, and env customization.`,
},
}
All is the ordered list of bundled skills.
Functions ¶
This section is empty.
Types ¶
type Agent ¶
type Agent struct {
Name string
ConfigDir string // parent config dir
SkillsDir string // where skill subdirectories live
SkipIfAbsent bool // when true, skip install if ConfigDir does not exist
}
Agent represents a target agent with its config directories.
type AgentInstallResult ¶
type AgentInstallResult struct {
Agent string `json:"agent"`
Skipped bool `json:"skipped"`
Installed []string `json:"installed"`
Updated []string `json:"updated"`
Errors []string `json:"errors,omitempty"`
}
AgentInstallResult reports what happened for one agent during install.
func Install ¶
func Install(scope Scope, baseDir string) []AgentInstallResult
Install installs all embedded skills for the given scope and base directory. For ScopeUser, agents whose config dirs do not exist are skipped. For ScopeProject, dirs are created as needed.
func InstallByName ¶ added in v0.7.36
func InstallByName(scope Scope, baseDir, name string) []AgentInstallResult
InstallByName installs a single skill by name. Returns nil if the skill name is not found.
type AgentSkillStatus ¶
type AgentSkillStatus struct {
Name string `json:"name"`
Description string `json:"description"`
State State `json:"state"`
}
AgentSkillStatus describes the state of a single skill for an agent.
type AgentStatus ¶
type AgentStatus struct {
Agent string `json:"agent"`
Available bool `json:"available"`
Skills []AgentSkillStatus `json:"skills"`
}
AgentStatus describes per-agent availability and skill states.
func Status ¶
func Status(scope Scope, baseDir string) []AgentStatus
Status returns per-agent, per-skill installation state without modifying anything. For ScopeUser, an agent is available only when its config dir exists. For ScopeProject, agents are always considered available.
type Scope ¶ added in v0.7.140
type Scope string
Scope determines where skills are installed.
const ( // ScopeUser installs into the user's agent config directories (~/.claude, ~/.agents). // Agents whose config directories do not exist are skipped. ScopeUser Scope = "user" // ScopeProject installs into the project's agent config directories (.claude, .agents). // Directories are created as needed; no pre-existing config dir is required. ScopeProject Scope = "project" )
type State ¶
type State string
State describes the installation state of a skill for a specific agent.
const ( StateMissing State = "missing" StateCurrent State = "current" StateOutdated State = "outdated" )
Skill installation states.
func SkillState ¶
SkillState checks the installation state of a skill for an agent.