asset

package

v2.2.9 Latest Latest Go to latest Published: Jul 29, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/sleuth-io/sx

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func InferDescription(content string) string
type Asset
type Type

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	TypeMCP = Type{
		Key:         "mcp",
		Label:       "MCP Server",
		Description: "Model Context Protocol server",
	}
	// TypeMCPRemote is a deprecated alias for TypeMCP.
	// Kept for backwards compatibility with existing lock files and vaults.
	TypeMCPRemote = TypeMCP
	TypeSkill     = Type{
		Key:         "skill",
		Label:       "Skill",
		Description: "Reusable AI skill",
	}
	TypeAgent = Type{
		Key:         "agent",
		Label:       "Agent",
		Description: "AI agent configuration",
	}
	TypeCommand = Type{
		Key:         "command",
		Label:       "Command",
		Description: "Slash command",
	}
	TypeHook = Type{
		Key:         "hook",
		Label:       "Hook",
		Description: "Git hook script",
	}
	TypeClaudeCodePlugin = Type{
		Key:         "claude-code-plugin",
		Label:       "Claude Code Plugin",
		Description: "Claude Code plugin with bundled assets",
	}
	TypeRule = Type{
		Key:         "rule",
		Label:       "Rule",
		Description: "Shared AI coding rule",
	}
	// TypeAppPlugin extends the sx DESKTOP APP itself ("extension" in UI
	// copy — docs/app-plugins-spec.md). Never installed into AI coding
	// clients: no client declares support for it, and the app hides it
	// from asset views (it surfaces only in the Extensions screen).
	TypeAppPlugin = Type{
		Key:         "app-plugin",
		Label:       "Extension",
		Description: "sx desktop app extension",
	}
)

Functions ¶

func InferDescription ¶

func InferDescription(content string) string

InferDescription pulls a short description out of markdown content: frontmatter description first, else the first non-heading paragraph line. One source of truth for every surface that needs a description when metadata doesn't carry one (publish backfill, vault listings, the app's draft editor).

Types ¶

type Asset ¶

type Asset struct {
	Name    string
	Version string
	Type    Type
	Config  map[string]string // Type-specific config (e.g., marketplace for plugins)
}

Asset represents a simple asset with just name, version, and type

type Type ¶

type Type struct {
	Key         string
	Label       string
	Description string
}

Type represents the type of asset (skill, command, agent, etc.)

func AllTypes ¶

func AllTypes() []Type

AllTypes returns all defined asset types

func ClientTypes ¶

func ClientTypes() []Type

ClientTypes returns the types AI coding clients can carry — AllTypes minus app-plugin, which extends the sx desktop app itself and never installs into an AI tool (docs/app-plugins-spec.md).

func FromString ¶

func FromString(key string) Type

FromString creates a Type from a string key

func (Type) IsValid ¶

func (t Type) IsValid() bool

IsValid checks if the asset type is valid

func (Type) MarshalText ¶

func (t Type) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler for TOML/JSON serialization

func (Type) String ¶

func (t Type) String() string

String returns the string representation (key) of the asset type

func (*Type) UnmarshalText ¶

func (t *Type) UnmarshalText(text []byte) error

UnmarshalText implements encoding.TextUnmarshaler for TOML/JSON deserialization

Source Files ¶

View all Source files

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