companion

package

v0.2.0 Latest Latest Go to latest Published: Jul 25, 2026 License: MIT Imports: 12 Imported by: 0

Details

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

Repository

github.com/Rememorio/codog

Links

Open Source Insights

Documentation ¶

Overview ¶

Package companion loads small, local terminal companion manifests.

Index ¶

Constants
Variables
func WriteExample(w io.Writer) error
type CatalogEntry
- func List(configHome string) []CatalogEntry
type Frames
type Manifest
- func Load(configHome string, id string) (*Manifest, error)
- func (m Manifest) Frame(state string) []string

Constants ¶

View Source

const (
	// BuiltinID identifies Codog's bundled terminal companion.
	BuiltinID = "codog"
	// DisabledID is the persisted value used to disable terminal companions.
	DisabledID = "off"
)

Variables ¶

View Source

var (
	// ErrInvalidID reports an unsafe or unsupported companion identifier.
	ErrInvalidID = errors.New("invalid companion id")
	// ErrInvalidManifest reports a malformed or unsafe companion manifest.
	ErrInvalidManifest = errors.New("invalid companion manifest")
)

Functions ¶

func WriteExample ¶

func WriteExample(w io.Writer) error

WriteExample writes a documented custom companion manifest to w.

Types ¶

type CatalogEntry ¶

type CatalogEntry struct {
	ID      string `json:"id"`
	Name    string `json:"name"`
	Builtin bool   `json:"builtin"`
}

CatalogEntry is the public summary used by companion pickers and reports.

func List ¶

func List(configHome string) []CatalogEntry

List returns the built-in companion and all valid local manifests.

type Frames ¶

type Frames struct {
	Ready   []string `json:"ready"`
	Running []string `json:"running,omitempty"`
	Waiting []string `json:"waiting,omitempty"`
	Failed  []string `json:"failed,omitempty"`
}

Frames contains the companion artwork for each runtime state. Missing state frames fall back to Ready.

type Manifest ¶

type Manifest struct {
	ID     string `json:"id"`
	Name   string `json:"name"`
	Frames Frames `json:"frames"`
}

Manifest describes one terminal companion.

func Load ¶

func Load(configHome string, id string) (*Manifest, error)

Load resolves a built-in or local custom companion. Empty and "off" values return nil without error.

func (Manifest) Frame ¶

func (m Manifest) Frame(state string) []string

Frame returns artwork for a normalized runtime state.

Source Files ¶

View all Source files

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