serverplugins

package
v1.4.0 Latest Latest
Warning

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

Go to latest
Published: Aug 29, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Overview

Package serverplugins is the declarative registry of Sarde's built-in server-side plugins: manifest.yaml carries their metadata and defaults/<name>.yaml their configurable fields, in the same blueprint shape used by clientplugins and external plugin blueprints.

The Go implementations live elsewhere (internal/plugin builtins and the subpackages registered in internal/build); this package only publishes what tooling such as `sarde plugins --format json` needs to describe them.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Fields

func Fields(slug string) []cfgutil.Field

Fields returns a plugin's declared config fields (sorted by name), or nil for an unknown plugin.

func Initialize

func Initialize() error

Initialize parses the embedded manifest and defaults once.

func RawFields

func RawFields(slug string) []byte

RawFields returns the raw defaults YAML for plugins that resolve their own config at build time (e.g. telescope), so the field list has one source.

func Slugs

func Slugs() []string

Slugs returns every manifest plugin name, sorted.

Types

type ManifestEntry

type ManifestEntry struct {
	Label          string `yaml:"label"`
	Description    string `yaml:"description"`
	Group          string `yaml:"group"`
	DefaultEnabled bool   `yaml:"default_enabled"`
	ConfigKey      string `yaml:"config_key"`
}

ManifestEntry is one plugin's metadata from manifest.yaml.

func Entry

func Entry(slug string) (ManifestEntry, bool)

Entry returns a plugin's manifest metadata.

Jump to

Keyboard shortcuts

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