setup

package
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 2, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Agent

type Agent struct {
	Name           string
	DisplayName    string
	ProjectRootDir string
	GlobalRootDir  string
	Universal      bool
	Detected       bool
}

Agent describes one supported agent/editor destination.

func DetectInstalledAgents

func DetectInstalledAgents(options ResolverOptions) ([]Agent, error)

func SelectAgents

func SelectAgents(all []Agent, names []string) ([]Agent, error)

func SupportedAgents

func SupportedAgents(options ResolverOptions) ([]Agent, error)

type FailureItem

type FailureItem struct {
	Skill Skill
	Agent Agent
	Path  string
	Mode  InstallMode
	Error string
}

FailureItem captures one failed installation mapping.

type InstallConfig

type InstallConfig struct {
	Bundle fs.FS

	ResolverOptions

	SkillNames []string
	AgentNames []string
	Global     bool
	Mode       InstallMode
}

InstallConfig describes one bundled-skill installation run.

type InstallMode

type InstallMode string

InstallMode determines how bundled skills are materialized for agents.

const (
	// InstallModeSymlink installs a canonical copy and symlinks agent paths to it.
	InstallModeSymlink InstallMode = "symlink"
	// InstallModeCopy copies the bundled skill into each target agent path.
	InstallModeCopy InstallMode = "copy"
)

type PreviewItem

type PreviewItem struct {
	Skill         Skill
	Agent         Agent
	CanonicalPath string
	TargetPath    string
	WillOverwrite bool
}

PreviewItem describes the on-disk plan for one skill/agent install pair.

func Preview

func Preview(cfg InstallConfig) ([]PreviewItem, error)

Preview resolves selected bundled skills and agents to on-disk install targets.

func PreviewBundledSkillInstall

func PreviewBundledSkillInstall(cfg InstallConfig) ([]PreviewItem, error)

PreviewBundledSkillInstall resolves the on-disk install plan for bundled skills.

type ResolverOptions

type ResolverOptions struct {
	CWD             string
	HomeDir         string
	XDGConfigHome   string
	CodeXHome       string
	ClaudeConfigDir string
}

ResolverOptions configures environment-sensitive path resolution.

type Result

type Result struct {
	Global     bool
	Mode       InstallMode
	Successful []SuccessItem
	Failed     []FailureItem
}

Result summarizes one bundled-skill installation run.

func Install

func Install(cfg InstallConfig) (*Result, error)

Install materializes bundled skills for the selected agents.

func InstallBundledSkills

func InstallBundledSkills(cfg InstallConfig) (*Result, error)

InstallBundledSkills materializes bundled public skills for the selected agents.

type Skill

type Skill struct {
	Name        string
	Description string
	Directory   string
}

Skill describes one bundled skill available for installation.

func ListBundledSkills

func ListBundledSkills() ([]Skill, error)

ListBundledSkills returns the public skills bundled into the compozy binary.

func ListSkills

func ListSkills(bundle fs.FS) ([]Skill, error)

ListSkills enumerates bundled public skills from the provided bundle.

func SelectSkills

func SelectSkills(all []Skill, names []string) ([]Skill, error)

SelectSkills filters a discovered catalog to the requested bundled skill names.

type SuccessItem

type SuccessItem struct {
	Skill         Skill
	Agent         Agent
	Path          string
	CanonicalPath string
	Mode          InstallMode
	SymlinkFailed bool
}

SuccessItem captures one successful installation mapping.

Directories

Path Synopsis
cmd
generatebundle command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL