plugin

package
v0.1.484 Latest Latest
Warning

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

 Go to latest Published: Sep 30, 2026 License: MIT Imports: 28 Imported by: 0

Documentation

Overview

Package plugin runs OpenCode's provider plugins for magpie.

A subscription a vendor may object to being used outside its own app is not built into magpie: a plugin signs in to it and makes its requests, the way OpenCode's plugins do (opencode-gemini-auth and the like), and magpie runs those same plugins. They are npm packages (or local files) written against OpenCode's plugin API (@opencode-ai/plugin, v1): their auth hook gives the sign-in methods and a loader whose fetch carries the requests, their config and provider hooks the models. magpie runs them under Bun, downloaded the first time a plugin is added, in one process (host.js) it talks to over stdin and stdout.

What magpie keeps: plugins.json, the plugins and the config handed to them (OpenCode's, its provider section: a plugin's options); the npm packages under plugins/; plugin-auth.json, the sign-ins, in OpenCode's auth.json shape (so one can be moved between the two).

Index

Constants

View Source 
const BunVersion = "1.3.14"

BunVersion is the Bun magpie downloads to run plugins with, the first time one is needed.

Variables

View Source 
var ErrFailed = errors.New("the sign-in failed")

ErrFailed is a sign-in the plugin says failed.

Functions

func APIKey 

func APIKey(ctx context.Context, provider string, method int, inputs map[string]string, key string) (string, error)

APIKey signs in with a key, as an "api" method does.

func AuthPath 

func AuthPath() string

AuthPath is the plugins' sign-ins, OpenCode's auth.json in shape.

func Bun 

func Bun(ctx context.Context) (string, error)

Bun is the bun to run plugins with: $MAGPIE_BUN when set, else the one magpie downloaded, downloading it now when there is none yet.

func Call 

func Call(ctx context.Context, method string, params, out any) error

Call starts the host if need be and asks it method.

func Dir 

func Dir() string

Dir is the folder magpie installs npm plugins into.

func Fetch 

func Fetch(ctx context.Context, r FetchRequest) (*http.Response, error)

Fetch sends r through the provider's plugin — its loader's fetch, or Bun's own when it gives none — and streams back the reply.

func Finish 

func Finish(ctx context.Context, session, code string) (string, error)

Finish waits for an OAuth sign-in to finish: an "auto" one on its own, a "code" one with the code pasted back. It gives the provider the sign-in was saved for.

func HasBun 

func HasBun() bool

HasBun is whether a Bun is at hand without a download.

func IsPath 

func IsPath(spec string) bool

IsPath is whether spec names a file or folder rather than a package, as OpenCode tells them apart.

func Name 

func Name(spec string) string

Name is the package spec names, without its version: "@scope/x" of "@scope/x@1.2", or the path.

func OnChange 

func OnChange(f func())

OnChange registers f to be told when a plugin sign-in or the plugins change (a sign-in saved or refreshed, a plugin added).

func Remove 

func Remove(ctx context.Context, name string) error

Remove takes a plugin off the list (and out of plugins/).

func Restart 

func Restart()

Restart stops the host, so the next call starts one with the plugins as they are now.

func Running 

func Running() bool

Running is whether a host is up.

func SetConfig 

func SetConfig(cfg map[string]any) error

SetConfig sets the OpenCode config the plugins are handed.

func SetOff 

func SetOff(name string, off bool) error

SetOff turns a plugin off or back on.

func Settle 

func Settle()

Settle waits for Cached's refreshes to end, then stops the host: for tests, whose folders the host runs in go when they end.

func SignOut 

func SignOut(ctx context.Context, provider string) error

SignOut forgets the provider's sign-in.

func SignedIn 

func SignedIn(provider string) bool

SignedIn is whether a plugin sign-in is kept for provider.

func Target 

func Target(spec string) string

Target is where the plugin is to load from: the installed package's folder, or the path.

func Update 

func Update(ctx context.Context) error

Update installs the version of each npm plugin its spec says now (latest, for the most part).

func Validate 

func Validate(ctx context.Context, provider string, method int, key, value string) (string, error)

Validate is what the method says is wrong with value as the answer to key, "" when nothing is.

Types

type Authorization 

type Authorization struct {
	Session      string `json:"session"`
	URL          string `json:"url"`
	Instructions string `json:"instructions"`
	Method       string `json:"method"`
}

Authorization is an OAuth sign-in begun: the page to open, and whether the plugin waits for it itself ("auto") or needs the code the page shows pasted back ("code").

func Authorize 

func Authorize(ctx context.Context, provider string, method int, inputs map[string]string) (Authorization, error)

Authorize begins an OAuth sign-in.

type Entry 

type Entry struct {
	// Spec is how it was added: an npm package (name, name@version) or a
	// path to a file or folder.
	Spec string `json:"spec"`
	// Off is set on a plugin the user turned off.
	Off bool `json:"off,omitempty"`
	// Options are handed to the plugin as its second argument, as
	// OpenCode's ["name", {options}] does.
	Options map[string]any `json:"options,omitempty"`
}

Entry is one plugin the user added.

func Add 

func Add(ctx context.Context, spec string) (Entry, error)

Add installs a plugin and adds it to the list, in place of one of the same package. A package is installed with its scripts left unrun.

type FetchRequest 

type FetchRequest struct {
	Provider string            `json:"provider"`
	Model    string            `json:"model"`
	NPM      string            `json:"npm"`
	URL      string            `json:"url"`
	Method   string            `json:"method"`
	Headers  map[string]string `json:"headers"`
	Body     []byte            `json:"-"`
	Session  string            `json:"session,omitempty"`
}

FetchRequest is a request a provider's plugin makes.

type List 

type List struct {
	Plugins []Entry `json:"plugins"`
	// Config is OpenCode's config the plugins are handed: its provider
	// section says what a plugin reads of it
	// (provider.google.options.projectId).
	Config map[string]any `json:"config,omitempty"`
}

List is plugins.json.

func Load 

func Load() List

Load reads plugins.json.

type Loaded 

type Loaded struct {
	Spec  string `json:"spec"`
	Error string `json:"error,omitempty"`
}

Loaded is how a plugin fared when the host loaded it.

func Plugins 

func Plugins(ctx context.Context) ([]Loaded, error)

Plugins is how each plugin fared when the host loaded it, starting the host if need be.

type Method 

type Method struct {
	Type  string `json:"type"`
	Label string `json:"label"`
}

Method is a way a plugin signs in: "oauth" (a browser, then a code pasted back or not) or "api" (a key).

type Model 

type Model struct {
	ID        string   `json:"id"`
	Name      string   `json:"name"`
	NPM       string   `json:"npm"` // the AI SDK package it is spoken to with
	URL       string   `json:"url"`
	APIID     string   `json:"apiId"`
	Context   int      `json:"context"`
	Input     int      `json:"input"`
	Output    int      `json:"output"`
	Reasoning bool     `json:"reasoning"`
	Image     bool     `json:"image"`
	Released  string   `json:"released"`
	Variants  []string `json:"variants"`
	Cost      *struct {
		Input  float64 `json:"input"`
		Output float64 `json:"output"`
	} `json:"cost"`
}

Model is a model a plugin's provider serves, as OpenCode lists it.

type Options 

type Options struct {
	BaseURL string            `json:"baseURL"`
	APIKey  string            `json:"apiKey"`
	Headers map[string]string `json:"headers"`
	Fetch   bool              `json:"fetch"`
}

Options is what the provider's auth loader gave: where its requests go, the key the AI SDK would send, and whether it carries them itself.

func LoaderOptions 

func LoaderOptions(ctx context.Context, provider string) (Options, error)

LoaderOptions runs the provider's auth loader (once per sign-in and host) and gives what it returned.

type Prompt 

type Prompt struct {
	Type        string `json:"type"` // text, select
	Key         string `json:"key"`
	Message     string `json:"message"`
	Placeholder string `json:"placeholder,omitempty"`
	Options     []struct {
		Label string `json:"label"`
		Value string `json:"value"`
		Hint  string `json:"hint,omitempty"`
	} `json:"options,omitempty"`
}

Prompt is a question a sign-in method asks before it starts.

func NextPrompt 

func NextPrompt(ctx context.Context, provider string, method int, inputs map[string]string) (*Prompt, error)

NextPrompt is the method's next question given the answers so far; nil when it has asked them all.

type Provider 

type Provider struct {
	ID        string   `json:"id"`   // OpenCode's: google, github-copilot
	Spec      string   `json:"spec"` // the plugin
	Name      string   `json:"name"`
	NPM       string   `json:"npm"`
	API       string   `json:"api"`
	Methods   []Method `json:"methods"`
	SignedIn  bool     `json:"signedIn"`
	AuthType  string   `json:"authType"`
	AccountID string   `json:"accountId"`
	Models    []Model  `json:"models"`
}

Provider is a provider a plugin signs in to.

func Cached 

func Cached() []Provider

Cached is the plugins' providers as last asked, without starting the host: what is known of them when magpie has only just started. A provider's sign-in is read afresh from plugin-auth.json.

func Providers 

func Providers(ctx context.Context) ([]Provider, error)

Providers asks the plugins for their providers, starting the host if need be, and keeps the answer for Cached.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.