skill

Documentation

Index

• Constants
• func ExtractionInboxPath(root string) string
• func FormatAvailableSkills(skills []Definition) string
• type AvailabilityOptions
• type Definition
• type Diagnostic
• type ExtractionCandidate
  • func AppendExtractionCandidatesIfNew(root string, candidates []ExtractionCandidate) ([]ExtractionCandidate, bool, error)
  • func DetectExtractionCandidates(sess session.Session, messages []session.Message, opts ExtractionOptions) []ExtractionCandidate
  • func FindExtractionCandidate(root string, id string) (ExtractionCandidate, error)
  • func ListExtractionCandidates(root string, opts ExtractionCandidateListOptions) ([]ExtractionCandidate, error)
  • func ReviewExtractionCandidate(root string, id string, review ExtractionCandidateReview) (ExtractionCandidate, error)
• type ExtractionCandidateAction
• type ExtractionCandidateListOptions
• type ExtractionCandidateReview
• type ExtractionCandidateStatus
• type ExtractionEvidence
• type ExtractionOptions
• type ExtractionProvenance
• type Frontmatter
  • func ParseFrontmatter(raw string) (Frontmatter, string, error)
• type LoadOptions
• type Snapshot
  • func Load(opts LoadOptions) (Snapshot, error)
  • func MirrorToWorkspace(workspaceDir string, snapshot Snapshot) (Snapshot, error)
• type Source
• type SourceDir

Constants

const (
	ExtractionCandidateStatusPending  ExtractionCandidateStatus = "pending"
	ExtractionCandidateStatusApproved ExtractionCandidateStatus = "approved"
	ExtractionCandidateStatusRejected ExtractionCandidateStatus = "rejected"

	ExtractionCandidateActionApprove ExtractionCandidateAction = "approve"
	ExtractionCandidateActionReject  ExtractionCandidateAction = "reject"
)

Functions

func ExtractionInboxPath

func ExtractionInboxPath(root string) string

func FormatAvailableSkills

func FormatAvailableSkills(skills []Definition) string

Types

type AvailabilityOptions

type AvailabilityOptions struct {
	OS               string
	Arch             string
	InstalledPlugins []string
	HasEnv           func(string) bool
	HasCommand       func(string) bool
}

type Definition

type Definition struct {
	Name                    string   `json:"name"`
	Description             string   `json:"description"`
	Slash                   string   `json:"slash,omitempty"`
	Aliases                 []string `json:"aliases,omitempty"`
	UserInvocable           bool     `json:"user_invocable"`
	Source                  Source   `json:"source"`
	FilePath                string   `json:"file_path"`
	RuntimePath             string   `json:"runtime_path,omitempty"`
	RequiresPlugin          string   `json:"requires_plugin,omitempty"`
	RequiresBins            []string `json:"requires_bins,omitempty"`
	RequiresEnv             []string `json:"requires_env,omitempty"`
	OS                      []string `json:"os,omitempty"`
	Arch                    []string `json:"arch,omitempty"`
	RecommendedTools        []string `json:"recommended_tools,omitempty"`
	RecommendedProjectFiles []string `json:"recommended_project_files,omitempty"`
	WakePhases              []string `json:"wake_phases,omitempty"`
	Tags                    []string `json:"tags,omitempty"`
	SmokeTests              []string `json:"smoke_tests,omitempty"`
	Content                 string   `json:"content,omitempty"`
}

type Diagnostic

type Diagnostic struct {
	Path    string `json:"path,omitempty"`
	Message string `json:"message"`
}

type ExtractionCandidate

type ExtractionCandidate struct {
	ID               string                    `json:"id"`
	Status           ExtractionCandidateStatus `json:"status"`
	Name             string                    `json:"name"`
	Title            string                    `json:"title"`
	Trigger          string                    `json:"trigger"`
	Summary          string                    `json:"summary"`
	UseCase          string                    `json:"use_case"`
	RecommendedTools []string                  `json:"recommended_tools,omitempty"`
	SourceSession    string                    `json:"source_session,omitempty"`
	MessageRange     string                    `json:"message_range,omitempty"`
	RepeatedCount    int                       `json:"repeated_count,omitempty"`
	Evidence         []ExtractionEvidence      `json:"evidence,omitempty"`
	Provenance       ExtractionProvenance      `json:"provenance"`
	CreatedAt        time.Time                 `json:"created_at"`
	UpdatedAt        time.Time                 `json:"updated_at"`
	ReviewedAt       time.Time                 `json:"reviewed_at,omitempty"`
	DraftPath        string                    `json:"draft_path,omitempty"`
	DraftName        string                    `json:"draft_name,omitempty"`
}

func AppendExtractionCandidatesIfNew

func AppendExtractionCandidatesIfNew(root string, candidates []ExtractionCandidate) ([]ExtractionCandidate, bool, error)

func DetectExtractionCandidates

func DetectExtractionCandidates(sess session.Session, messages []session.Message, opts ExtractionOptions) []ExtractionCandidate

func FindExtractionCandidate

func FindExtractionCandidate(root string, id string) (ExtractionCandidate, error)

func ListExtractionCandidates

func ListExtractionCandidates(root string, opts ExtractionCandidateListOptions) ([]ExtractionCandidate, error)

func ReviewExtractionCandidate

func ReviewExtractionCandidate(root string, id string, review ExtractionCandidateReview) (ExtractionCandidate, error)

type ExtractionCandidateAction

type ExtractionCandidateAction string

type ExtractionCandidateListOptions

type ExtractionCandidateListOptions struct {
	Status ExtractionCandidateStatus
}

type ExtractionCandidateReview

type ExtractionCandidateReview struct {
	Action    ExtractionCandidateAction `json:"action"`
	DraftPath string                    `json:"draft_path,omitempty"`
	DraftName string                    `json:"draft_name,omitempty"`
	Note      string                    `json:"note,omitempty"`
}

type ExtractionCandidateStatus

type ExtractionCandidateStatus string

type ExtractionEvidence

type ExtractionEvidence struct {
	MessageID string `json:"message_id,omitempty"`
	Index     int    `json:"index"`
	Role      string `json:"role"`
	Snippet   string `json:"snippet"`
}

type ExtractionOptions

type ExtractionOptions struct {
	Now           time.Time
	MaxCandidates int
}

type ExtractionProvenance

type ExtractionProvenance struct {
	Source        string    `json:"source,omitempty"`
	SessionID     string    `json:"session_id,omitempty"`
	MessageRange  string    `json:"message_range,omitempty"`
	SourceSummary string    `json:"source_summary,omitempty"`
	ExtractedAt   time.Time `json:"extracted_at,omitempty"`
}

type Frontmatter

type Frontmatter struct {
	Name                    string
	Description             string
	Slash                   string
	Aliases                 []string
	UserInvocable           *bool
	RequiresPlugin          string
	RequiresBins            []string
	RequiresEnv             []string
	OS                      []string
	Arch                    []string
	RecommendedTools        []string
	RecommendedProjectFiles []string
	WakePhases              []string
	Tags                    []string
	SmokeTests              []string
}

func ParseFrontmatter

func ParseFrontmatter(raw string) (Frontmatter, string, error)

type LoadOptions

type LoadOptions struct {
	Sources      []SourceDir
	Availability AvailabilityOptions
}

type Snapshot

type Snapshot struct {
	Version     int64        `json:"version"`
	Skills      []Definition `json:"skills"`
	Diagnostics []Diagnostic `json:"diagnostics,omitempty"`
}

func Load

func Load(opts LoadOptions) (Snapshot, error)

func MirrorToWorkspace

func MirrorToWorkspace(workspaceDir string, snapshot Snapshot) (Snapshot, error)

type Source

type Source string

const (
	SourceWorkspace Source = "workspace"
	SourceUser      Source = "user"
	SourceBundled   Source = "bundled"
)

type SourceDir

type SourceDir struct {
	Source Source
	Dir    string
}