plugin

package
v0.1.1239 Latest Latest
Warning

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

 Go to latest Published: Oct 14, 2026 License: MIT Imports: 42 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.4.2"

BunVersion is the Bun magpie downloads to run plugins with the first time one is needed, and the oldest it runs them on: newer releases are taken as they come (see CheckBun). Update bunSums below, testenv.MinBun and test.yml's bun-version when it changes.

View Source 
const MarketURL = "https://raw.githubusercontent.com/magpie-community/plugins/main/registry.json"

MarketURL is where the list is kept; MAGPIE_PLUGIN_MARKET moves it, and "off" keeps to the built-in copy.

View Source 
const NewAccount = "new"

NewAccount is the account a sign-in goes to when it is a new one: the provider's own id while nothing is kept there. A sign-in to an account already signed in replaces that one's instead.

View Source 
const Topic = "magpie-plugin"

Topic is the GitHub topic that puts a repository on the Plugins page.

Variables

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

ErrFailed is a sign-in the plugin says failed.

View Source 
var ProxyFor func(provider, key string) string

ProxyFor is the proxy choice (netproxy.With's) of the provider's account at key, or of the provider for key "": set by the providers magpie keeps, which know them.

Functions

func Agent added in v0.1.1161 

func Agent(target string) (file string, only bool)

Agent is the agent a plugin at target adds magpie's wiring for: the file its package.json's magpie.agent names, or the file itself for a path to a *.agent.js (or .mjs). only is whether it is nothing else: no OpenCode plugin for the host to load (no main, no exports).

func Answered added in v0.1.1224 

func Answered() bool

Answered is whether what Cached gives now is the plugins' own answer, rather than what was kept from before they were last asked. A page that would otherwise read "signs in to nothing" out of an empty list can say so only when this holds: an empty list before the answer arrives means "not asked yet", not "none" (#1112).

func AuthPath 

func AuthPath() string

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

func Auths added in v0.1.506 

func Auths(provider string) map[string]map[string]any

Auths are provider's sign-ins as plugin-auth.json keeps them, by key.

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 and keeps up to date, downloading it now when there is none yet.

func BunInUse added in v0.1.585 

func BunInUse() string

BunInUse is the version of the Bun plugins run on (or will, once it is downloaded): the newest magpie took, else BunVersion.

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 CheckBun added in v0.1.585 

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

CheckBun takes Bun's newest release when it is newer than the one in use, out two days and not set aside: downloaded, checked, tried, then switched to, the host restarted gracefully. It says the version taken, "" when none was.

func Clashes added in v0.1.1144 

func Clashes(loaded []Loaded) map[string][]Clash

Clashes are the provider ids each loaded plugin shares with another, by the plugin's spec.

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 GitBehind added in v0.1.1169 

func GitBehind(spec, head string) bool

GitBehind is whether the git plugin spec's repository has moved on from the commit installed: both known, and not the same.

func GitCommit added in v0.1.1169 

func GitCommit(spec string) string

GitCommit is the commit bun installed of the git plugin spec, as bun recorded it (7 hex digits for a GitHub one, 40 for one fetched with git); "" for one that isn't git, or isn't installed.

func GitHead added in v0.1.1169 

func GitHead(ctx context.Context, spec string, fresh bool) (string, error)

GitHead is the commit the git spec's repository is at now, asked at most every headTTL (fresh: asked now), "" with why when it couldn't be told.

func GitHeadCached added in v0.1.1169 

func GitHeadCached(spec string) string

GitHeadCached is what the git spec's repository said last, never asked now; "" when it hasn't been asked or didn't answer.

func GitHeads added in v0.1.1169 

func GitHeads(ctx context.Context) map[string]string

GitHeads is the commit each installed git plugin's repository is at, as GitHead tells it, a few asked at once; one that couldn't be told is left out.

func HasBun 

func HasBun() bool

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

func Icon added in v0.1.497 

func Icon(spec, id string) string

Icon is the icon the market gives the plugin spec, or else any listed plugin signing in to provider id; "" when none does. It never goes to the network: the list fetched last, else the cached copy, else the one built in.

func Import added in v0.1.506 

func Import(ctx context.Context, provider string, auth map[string]any) (string, error)

Import keeps auth (a plugin-auth.json entry) as one more of provider's accounts — or, the same account as one kept already, in its place — and gives the account's key. The plugin's host is started for it: it alone writes the file while it runs.

func InMagpieOnly added in v0.1.1161 

func InMagpieOnly(target string) bool

InMagpieOnly is whether everything a plugin at target has runs in magpie's own process, its gateway middleware and its agent, so the host has nothing of it to load.

func Info added in v0.1.489 

func Info(ctx context.Context, names []string) map[string]NPM

Info is what npm says of each package, asked at most hourly: a few at a time, and for no longer than npmAll in all (or ctx). A package npm didn't answer for in time is what it said last, or missing when it never has; its answer, when it comes, is kept for the next time. A package npm doesn't have has no Version.

func InfoCached added in v0.1.615 

func InfoCached(names []string) map[string]NPM

InfoCached is what npm said last of each package it was asked of, however long ago, without asking again; a package never asked isn't in it.

func InstallMissing added in v0.1.1231 

func InstallMissing(ctx context.Context) (int, error)

InstallMissing installs again each plugin on the list whose package isn't in plugins/ (a git one's too when package.json no longer names it), as its spec says, and says how many it installed. Nothing else does: an update skips a plugin with no version installed, and the host says "no such plugin" for it at every start until the user takes it off and adds it again (#2002, anganing: after an update every plugin switched on said so, on Windows). One switched off is installed too, so it loads when it is switched back on.

func Installed added in v0.1.489 

func Installed(spec string) string

Installed is the version of the plugin spec installed, "" for a path or one not installed.

func InstalledIcon added in v0.1.1210 

func InstalledIcon(spec string) string

InstalledIcon is the picture the installed plugin spec's package.json gives in magpie.icon, as ownIcon takes one: the plugin's own, for its row, apart from those its providers give themselves in the auth hook (#1775). "" for none, or a plugin that is one file.

func IsGit added in v0.1.603 

func IsGit(spec string) bool

IsGit is whether spec names a git repository rather than an npm package or a path. The package bun installs from it is named by its own package.json, not by spec.

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 IsPi added in v0.1.751 

func IsPi(target string) bool

IsPi is whether the plugin at target is pi's (a pi package or extension) rather than OpenCode's, as host.js's pi.js tells them.

func KeepBunUpdated added in v0.1.585 

func KeepBunUpdated(ctx context.Context)

KeepBunUpdated looks for a newer Bun a little after magpie starts, then every bunEvery, while there are plugins to run on it.

func KeepUpdated added in v0.1.573 

func KeepUpdated(ctx context.Context)

KeepUpdated looks for plugin updates a little after magpie starts, then every updateEvery, run by the magpie serving the gateway (one magpie, never two at once).

func ListStamp added in v0.1.1012 

func ListStamp() string

ListStamp changes when plugins.json does.

func ListedAt added in v0.1.552 

func ListedAt() (time.Time, bool)

ListedAt is when the plugins last listed their providers and models, as a built-in's list is dated by when it was fetched.

func Middleware added in v0.1.1012 

func Middleware(target string) (file string, only bool)

Middleware is the gateway middleware a plugin at target has: the file its package.json's magpie.middleware names, or the file itself for a path to a *.middleware.js (or .mjs). only is whether it is nothing else: no OpenCode plugin for the host to load (no main, no exports).

func Name 

func Name(spec string) string

Name is the package spec names, without its version: "@scope/x" of "@scope/x@1.2", the package installed from a git repository (the spec itself until it is), or the path.

func Official added in v0.1.573 

func Official(pkg string) bool

Official is whether the package is the community's, magpie's own, which magpie keeps up to date by itself.

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 OnSignIn added in v0.1.547 

func OnSignIn(f func(provider, account, said string))

OnSignIn registers f to be told what a plugin said, outside an answer, its account's sign-in is: "expired", "kept" or "renewed" (a models hook's error saying it).

func OptionOn added in v0.1.1231 

func OptionOn(chosen map[string]map[string]bool, provider string, o Option) bool

OptionOn is option o of a provider as it stands with the user's values in chosen (settings' PluginOptions): theirs, else the plugin's default.

func OptionsExample added in v0.1.1021 

func OptionsExample(target string) map[string]any

OptionsExample is the options a plugin at target suggests, from its package.json's magpie.options: what its options editor starts from before any are set.

func PackageName added in v0.1.506 

func PackageName(spec string) string

PackageName is the npm package spec is: its name, or, for a plugin added from a folder or file (a checkout of it), the name its package.json gives.

func Pinned added in v0.1.573 

func Pinned(spec string) bool

Pinned is whether spec names a version (or a range or a tag other than latest): the user chose it, and it stays. A git one's version is its repository's, not npm's: it is never pinned, and never asked of npm.

func Prefer added in v0.1.1144 

func Prefer(name, id string) error

Prefer has the plugin named serve provider id, which another plugin signs in to as well (Clash): the host runs it for id from now on, the other one keeping its other providers. A plugin removed takes its picks with it; one switched off leaves the id to the others until it is on again.

func ProviderOf added in v0.1.500 

func ProviderOf(key string) string

ProviderOf is the provider an account key is one of.

func RefreshMarket added in v0.1.721 

func RefreshMarket()

RefreshMarket has the next Market fetch the list again, as with the 「国内镜像」 switch just turned on; the one held is kept till then.

func Refreshed added in v0.1.591 

func Refreshed()

Refreshed waits for Cached's refreshes in the background to end, the host left running: for tests that watch the providers' list on disk.

func ReloadInfo added in v0.1.615 

func ReloadInfo()

ReloadInfo forgets what npm said, as kept in memory: the next ask reads it from disk again, as a magpie just started does.

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. A host answering calls (a reply streaming, a sign-in waiting for its browser) finishes them first, while the calls made from now on go to the new one: a plugin updating never cuts a reply.

func Restore added in v0.1.506 

func Restore(ctx context.Context, provider, key string, auth map[string]any) error

Restore puts auth back as provider's account key.

func Running 

func Running() bool

Running is whether a host is up.

func SameCommit added in v0.1.1169 

func SameCommit(a, b string) bool

SameCommit is whether two commits are one: an abbreviated sha names the full one it begins.

func SetOff 

func SetOff(name string, off bool) error

SetOff turns a plugin off or back on.

func SetOptions added in v0.1.1021 

func SetOptions(name string, opts map[string]any) error

SetOptions sets the options a plugin is handed (a middleware's ctx.options); nil takes them away.

func SetProviderOptions added in v0.1.1231 

func SetProviderOptions(ctx context.Context) error

SetProviderOptions hands the user's option values (settings' PluginOptions) to the host running now; a host started later reads them at its start.

func Settle 

func Settle()

Settle waits for Cached's refreshes to end, stops the host, waits for the hooks told of a change (Told) and forgets the plugins (UseCached nil): for tests, whose folders the host runs in go when they end, so the next test starts with nothing of this one's running or seen. Each ask is bounded and the retries are few, so this waits a bounded time even for a host that never answers.

func ShortCommit added in v0.1.1169 

func ShortCommit(sha string) string

ShortCommit is a commit as the page shows it, its first 7 digits.

func ShortName added in v0.1.1021 

func ShortName(pkg string) string

ShortName is a package's name without its scope and the words every package of its kind has: model-map for @magpie-community/middleware-model-map, zed for @magpie-community/opencode-zed-auth. A plugin added from a folder is named by its path, which on Windows ends after a backslash.

func SignOut 

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

SignOut forgets one account of the provider's, every one when account is "".

func SignedIn 

func SignedIn(provider string) bool

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

func Take added in v0.1.506 

func Take(ctx context.Context, provider string, keys []string) (map[string]map[string]any, error)

Take gives provider's accounts named by keys (every one when there are none) and signs them out in one step, so the plugin renews none of their tokens after it gave them.

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 Told added in v0.1.1222 

func Told()

Told waits for the hooks told of a change or a sign-in (OnChange, OnSignIn) to end: for tests, so that a change one test made is not told in the next, nor written into its folder as it goes.

func Update 

func Update(ctx context.Context) error

Update installs npm's newest version (asked now, installAt) of each npm plugin, and fetches each git one again. A plugin pinned to a version that npm has a newer one of is updated too, and unpinned, as its row's Update does: the page counts it in Update all, and the CLI's update says it installs the newest of each (ARNO on Discord: a plugin updated with Update all still said an update was out, pinned where it was). A pinned one already at npm's newest stays as its spec says.

func Upgrade added in v0.1.489 

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

Upgrade installs the newest version of one plugin: npm's, or its git repository's commit now. One bun won't install says why.

func UseCached added in v0.1.538 

func UseCached(ps []Provider)

UseCached is for tests: Cached answers with ps, as though the plugins had just been asked, without Bun; nil forgets them.

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.

func Version added in v0.1.506 

func Version(spec string) string

Version is the version of the package spec installed (or checked out at its path), "" when there is none.

Types

type Account added in v0.1.500 

type Account struct {
	Key       string `json:"key"`
	Type      string `json:"type"`
	AccountID string `json:"accountId"`
	// Hint tells an account with no id from another: the end of its key.
	Hint string `json:"hint,omitempty"`
	// Models are the ids of the provider's models this account has, when
	// the provider has more than one account; none, it has them all.
	Models    []string `json:"models,omitempty"`
	FellBack  bool     `json:"fellBack,omitempty"`
	ListError string   `json:"listError,omitempty"`
}

Account is one account a provider is signed in to: Key is where plugin-auth.json keeps it (the provider's id, else id#slot).

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, account string) (Authorization, error)

Authorize begins an OAuth sign-in to account (a key, or NewAccount), through the proxy ctx names (netproxy.With): the plugin's requests for it, there and in Finish, go through that one (#1663).

type Checked added in v0.1.552 

type Checked struct {
	Models  []string `json:"models"`
	Usage   *Usage   `json:"usage"`
	Refused string   `json:"refused"`
}

Checked is what trying an account gave: the model ids the plugin lists for it, its usage read (nil when the plugin tells none), and why its models hook said the vendor refused the sign-in, if it did.

func Check added in v0.1.506 

func Check(ctx context.Context, provider, account string) (Checked, error)

Check tries one of provider's accounts as a request would — its auth loader, then its models as the plugin lists them for it — and reads its usage, which asks the vendor of the account itself. It fails when the plugin reached none of the places it asked (the vendor offline): a models hook falling back to a list it keeps proves nothing.

type Checkin added in v0.1.1085 

type Checkin struct {
	Outcome string  `json:"outcome"`
	Credit  float64 `json:"credit"`
	Streak  int     `json:"streak"`
	Message string  `json:"message"`
}

Checkin is what came of an account's daily check-in, as the plugin's auth.checkin said: Outcome is one of claimed, done, ineligible, inactive, captcha and failed.

func AccountCheckin added in v0.1.1085 

func AccountCheckin(ctx context.Context, provider, account string) (Checkin, error)

AccountCheckin asks the plugin to check account of provider in for the day.

type Clash added in v0.1.1144 

type Clash struct {
	ID string `json:"id"` // the provider id, OpenCode's
	By string `json:"by"` // the spec of the plugin that serves it
	// With are the other plugins that sign in to it
	With []string `json:"with"`
}

Clash is a provider id more than one plugin signs in to. The host runs one of them for it: the one the user picked (Prefer), else the last in plugins.json, as OpenCode does. The others' sign-in to it goes unused.

type Entry 

type Entry struct {
	// Spec is how it was added: an npm package (name, name@version), a git
	// repository (github:owner/repo, git+https://…) 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"`
	Account  string            `json:"account,omitempty"` // the provider's first when ""
	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"`
	// Proxy is the provider's or the account's own proxy (netproxy.With):
	// "direct", or its URL; "" follows magpie's. Fetch takes it from ctx
	// when it isn't set.
	Proxy string `json:"proxy,omitempty"`
}

FetchRequest is a request a provider's plugin makes.

type GitHubLimit added in v0.1.1226 

type GitHubLimit struct {
	Until string `json:"until,omitempty"`
	Token bool   `json:"token,omitempty"`
}

GitHubLimit is GitHub's rate limit used up: until when (RFC 3339, "" when GitHub didn't say), and whether the request carried a GitHub token.

type Hit added in v0.1.489 

type Hit struct {
	Package string `json:"package"`
	NPM
}

Hit is a package npm's search found. 

func Search(ctx context.Context, q string) ([]Hit, error)

Search asks npm for plugins matching q: OpenCode plugins, and pi packages, which list "pi-package" among their keywords as pi's own gallery asks.

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"`
	// Prefer is the plugin the user picked for a provider id more than
	// one plugin signs in to (a plugin of their own beside a third
	// party's): provider id → that plugin's spec. Without it the last of
	// them in Plugins serves the id, as in OpenCode.
	Prefer map[string]string `json:"prefer,omitempty"`
}

List is plugins.json.

func Load 

func Load() List

Load reads plugins.json. What it gives is the caller's to change at every level: the mutators (Add, Remove, SetOff, SetConfig) each get their own copy, so nothing they change reaches what list keeps.

type Listing added in v0.1.489 

type Listing struct {
	Package   string            `json:"package"`
	Name      string            `json:"name"`
	Icon      string            `json:"icon,omitempty"`
	Providers []string          `json:"providers,omitempty"` // OpenCode's ids of those it signs in to
	Community bool              `json:"community,omitempty"` // written by magpie's community
	Replaces  string            `json:"replaces,omitempty"`  // the built-in subscription it does the work of
	Kind      string            `json:"kind,omitempty"`      // "middleware" for gateway middleware, "agent" for an agent; none for a provider
	Summary   map[string]string `json:"summary,omitempty"`   // by language: en, zh
}

Listing is a plugin the market suggests.

func Market added in v0.1.489 

func Market(ctx context.Context) []Listing

Market is the list of plugins magpie suggests: fetched at most every six hours, else the copy fetched last, else the one built in.

type Loaded 

type Loaded struct {
	Spec  string `json:"spec"`
	Error string `json:"error,omitempty"`
	// Provides are the provider ids its auth hooks sign in to
	Provides []string `json:"provides,omitempty"`
	// ServedBy is, for each of them another plugin signs in to and
	// serves, that plugin's spec: the host runs one plugin per provider
	// id (Prefer)
	ServedBy map[string]string `json:"servedBy,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"`
	// Placeholder is the hint an "api" method gives in its key's field
	// (magpie's own field: OpenCode's says "API key")
	Placeholder string `json:"placeholder,omitempty"`
}

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

func (Method) KeyTitle added in v0.1.553 

func (m Method) KeyTitle(name string) string

KeyTitle is what an "api" method's key is asked as: its label, as OpenCode's dialog titles it, unless that only says "API key" (or nothing), when it is name's API 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"`
	// Free is set by the plugin on a model the plan serves at no cost to
	// its allowance (WorkBuddy's "credits": "x0.00")
	Free bool `json:"free"`
	// Rate is set by the plugin on a model whose price its vendor lists:
	// the credits a request costs, as a multiple (Qoder's price_factor
	// 0.5, WorkBuddy's "credits": "x0.03"), and RateWas the price before a
	// discount running now. The plugin gives either as a number or as the
	// vendor writes it ("x0.03"), on the model it lists (m.rate,
	// m.rateWas); 0 is none.
	Rate    float64 `json:"rate"`
	RateWas float64 `json:"rateWas"`
	Cost    *struct {
		Input  float64 `json:"input"`
		Output float64 `json:"output"`
	} `json:"cost"`
	// ImageSaid is whether the plugin (or models.dev) said if it takes
	// images: Image false without it is not known
	ImageSaid bool `json:"imageSaid"`
	// Inputs and Outputs are the kinds capabilities.input and .output say
	// the model takes and gives (text, image, audio, video, pdf), in
	// OpenCode's order: not image alone (#1595)
	Inputs  []string `json:"inputs,omitempty"`
	Outputs []string `json:"outputs,omitempty"`
	// Fast is set by the plugin on a model it runs in its vendor's fast
	// mode when the request says service_tier "priority" (m.fast: Cursor's
	// plugin from 0.2.2, for a model Cursor has a fast variant of)
	Fast bool `json:"fast"`
	// Decides is set by the plugin on a model that answers System One's
	// questions rather than a conversation (m.decides: a decision model
	// not named jev-…, Clef or a vendor's own). It counts only where the
	// provider says it serves a decision API (Provider.Decide).
	Decides bool `json:"decides,omitempty"`
}

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

type NPM added in v0.1.489 

type NPM struct {
	Version     string `json:"version,omitempty"` // latest; none when npm has no such package
	Description string `json:"description,omitempty"`
	Publisher   string `json:"publisher,omitempty"`
	License     string `json:"license,omitempty"`
	Homepage    string `json:"homepage,omitempty"`
	Repository  string `json:"repository,omitempty"`
	Weekly      int    `json:"weekly"` // downloads last week
	// Icon is the picture the package gives in package.json's
	// magpie.icon, as npm has it: magpie checks and keeps it before the
	// page shows it, as a GitHub-tagged plugin's (the GUI's listings)
	Icon string `json:"icon,omitempty"`
}

NPM is what npm says of a package now.

type Option added in v0.1.1231 

type Option struct {
	Key         string `json:"key"`
	Label       string `json:"label"`
	Description string `json:"description,omitempty"`
	Default     bool   `json:"default,omitempty"`
	// Confirm is asked before the switch is turned on, when the plugin
	// says turning it on does something the user should agree to
	Confirm string `json:"confirm,omitempty"`
}

Option is a switch a plugin declares for its provider (auth.options, #2038): magpie shows it, keeps the user's value in settings' PluginOptions and hands it to the plugin (input.magpie.option). Nothing runs when it changes.

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, account string) (Options, error)

LoaderOptions runs the provider's auth loader for account (once per sign-in and host) and gives what it returned; account "" is the provider's first.

type Page added in v0.1.489 

type Page struct {
	Readme  string    `json:"readme"`
	Updated time.Time `json:"updated"`
}

Page is a package's page: its README and when it last changed.

func Readme added in v0.1.489 

func Readme(ctx context.Context, name string) (Page, error)

Readme is the package's README, as npm has it, or — for a plugin added from a folder on this computer or a git repository — the one its folder carries.

type Prompt 

type Prompt struct {
	Type        string `json:"type"` // text, select, password (text typed unseen, #1982)
	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"`
	// Icon is the picture the plugin gives the provider, as it said it:
	// an https URL or a data:image URI (internal/provider keeps it)
	Icon string `json:"icon,omitempty"`
	// Usage says the plugin tells each account's allowance (auth.usage)
	Usage bool `json:"usage"`
	// Checkin says the plugin presses its vendor's daily check-in for each
	// account (auth.checkin)
	Checkin bool `json:"checkin,omitempty"`
	// Options are the switches the plugin declares for the provider
	// (auth.options, #2038), as the host checked them
	Options []Option `json:"options,omitempty"`
	// Decide says the plugin serves a decision API (TypeSafe's System
	// One) for this provider: its config hook set decide on it. magpie
	// posts the questions to the provider's own base, at /systemone,
	// through the plugin's fetch (#1514).
	Decide bool `json:"decide,omitempty"`
	// Searches says the provider's upstream answers a web search tool
	// offered on its Anthropic or Responses API by itself, as a custom
	// provider's Searches does (#825): its config hook set searches on it
	// (#2027), for a plugin in front of Claude's or Codex's API.
	Searches  bool    `json:"searches,omitempty"`
	SignedIn  bool    `json:"signedIn"`
	AuthType  string  `json:"authType"`
	AccountID string  `json:"accountId"`
	Models    []Model `json:"models"`
	// FellBack says the plugin's models hook couldn't fetch its vendor's
	// list and gave the default one back.
	FellBack bool `json:"fellBack,omitempty"`
	// ListError is why it fell back, as the models hook threw it or its
	// last fetch failed: the editor says so over the short list.
	ListError string `json:"listError,omitempty"`
	// Accounts are the accounts signed in to it, the one kept under its
	// own id first; SignedIn, AuthType and AccountID are that one's.
	Accounts []Account `json:"accounts"`
	// MaxConcurrency is how many requests the plugin says each of its
	// accounts takes at once (magpie's own field, which OpenCode ignores:
	// the auth hook's maxConcurrency, else package.json's
	// magpie.maxConcurrency); 0 for none said. The user's setting on the
	// provider goes over it.
	MaxConcurrency int `json:"maxConcurrency,omitempty"`
}

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 Listed added in v0.1.1232 

func Listed() ([]Provider, bool)

Listed is every provider the plugins last listed, an off plugin's among them, as Cached keeps them, with no sign-in read: false when no listing is known (none kept, plugin-providers.json missing or unreadable), which is never "no providers".

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.

type Saved added in v0.1.500 

type Saved struct {
	Provider string `json:"provider"`
	Account  string `json:"account"`
}

Saved is where a sign-in was kept: the provider (a plugin may sign in to another than asked) and the account's key.

func APIKey 

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

APIKey signs in to account (a key, or NewAccount) with a key, as an "api" method does, through the proxy ctx names.

func Finish 

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

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

type Tagged added in v0.1.1099 

type Tagged struct {
	Spec        string    `json:"spec"`  // what Install adds: its npm name when npm has it from this repository, else github:owner/repo
	Repo        string    `json:"repo"`  // owner/repo
	URL         string    `json:"url"`   // its page on GitHub
	Owner       string    `json:"owner"` // its owner's login
	OwnerAvatar string    `json:"ownerAvatar,omitempty"`
	Description string    `json:"description,omitempty"`
	Stars       int       `json:"stars"`
	License     string    `json:"license,omitempty"` // SPDX id
	Pushed      time.Time `json:"pushed"`
	// from its package.json on the default branch: what bun will install
	// it as, its version, and whether it is gateway middleware or an agent
	Package string `json:"package,omitempty"`
	Version string `json:"version,omitempty"`
	Kind    string `json:"kind,omitempty"` // "middleware" or "agent" when that is all it is
	// its package.json's magpie.icon, as an installed plugin gives its
	// provider one: an https URL or a data:image URI, as it is written
	Icon string `json:"icon,omitempty"`
}

Tagged is a repository tagged with Topic.

func TaggedRepos added in v0.1.1099 

func TaggedRepos(ctx context.Context) []Tagged

TaggedRepos are the repositories tagged with Topic, the most starred first: GitHub asked at most every ten minutes (its search lets 10 a minute through without a token), else what it said last, kept on disk. Archived repositories, forks and magpie-community's own (the market lists those) are left out, as is one whose package.json doesn't parse, which bun couldn't install either. A repository whose package.json didn't come in time is as the list had it last, and the list is asked again in taggedRetry. MAGPIE_PLUGIN_MARKET=off keeps to none.

type Updated added in v0.1.573 

type Updated struct {
	Package string    `json:"package"`
	From    string    `json:"from"`
	To      string    `json:"to"`
	At      time.Time `json:"at"`
}

Updated is a plugin magpie updated by itself.

func LastUpdated added in v0.1.573 

func LastUpdated(pkg string, since time.Time) (Updated, bool)

LastUpdated is the update magpie made by itself to the package since the time given, if it made one.

type Updates added in v0.1.573 

type Updates struct {
	Checked time.Time `json:"checked"`
	// Waiting are the plugins with a newer version that magpie leaves to
	// the reader: someone else's, or one pinned to a version.
	Waiting []Waiting `json:"waiting"`
	// Updated are the plugins magpie updated by itself, the latest last.
	Updated []Updated `json:"updated"`
}

Updates is what magpie's last look at npm found for the plugins.

func CheckUpdates added in v0.1.573 

func CheckUpdates(ctx context.Context) (Updates, error)

CheckUpdates asks npm for each plugin's newest version, updates the community's (unpinned, switched on) to it and notes the others' as waiting. The plugins updated are loaded again, a reply streaming through the old ones finishing first.

func PendingUpdates added in v0.1.573 

func PendingUpdates() Updates

PendingUpdates is what the last look found, less what has changed since: a plugin updated, removed or switched off since waits no more.

type Usage added in v0.1.514 

type Usage struct {
	Plan    string        `json:"plan"`
	Until   string        `json:"until"` // RFC 3339, "" when not told
	Renew   string        `json:"renew"`
	Balance string        `json:"balance"`
	Error   string        `json:"error"`
	User    string        `json:"user"`
	SignIn  string        `json:"signIn"` // "expired", "kept", "renewed" or ""
	Windows []UsageWindow `json:"windows"`
	Resets  *UsageResets  `json:"resets"`
}

Usage is how much of its allowance one account has used, as the plugin's auth.usage tells it (host.js has the shape).

func AccountUsage added in v0.1.514 

func AccountUsage(ctx context.Context, provider, account string) (Usage, error)

AccountUsage asks the plugin for account's usage of provider.

type UsageResets added in v0.1.514 

type UsageResets struct {
	Count    int    `json:"count"`
	Until    string `json:"until"`
	ByWindow bool   `json:"byWindow"`
	FiveHour int    `json:"fiveHour"`
	Weekly   int    `json:"weekly"`
}

UsageResets are the rate-limit resets an account may spend.

type UsageWindow added in v0.1.514 

type UsageWindow struct {
	Name      string   `json:"name"`
	Used      float64  `json:"used"`     // percent
	ResetsAt  string   `json:"resetsAt"` // RFC 3339
	ResetSecs int64    `json:"resetSecs"`
	Display   string   `json:"display"`
	Amount    float64  `json:"amount"` // of Limit, in Unit: the window's own count, used
	Limit     float64  `json:"limit"`
	Unit      string   `json:"unit"`
	Span      float64  `json:"span"` // seconds
	Model     string   `json:"model"`
	Models    []string `json:"models"`
	NotModels []string `json:"notModels"`
	Aside     bool     `json:"aside"`
	// RunsOutAt (RFC 3339) is when the soonest credits left in the window
	// are lost, and RunsOut how many, when the vendor's credits expire
	// apart from the window's reset (WorkBuddy's packages)
	RunsOutAt string  `json:"runsOutAt"`
	RunsOut   float64 `json:"runsOut"`
}

type VersionCheck added in v0.1.663 

type VersionCheck struct {
	Spec    string `json:"spec"`
	Package string `json:"package"`
	Version string `json:"version"`          // installed
	Latest  string `json:"latest,omitempty"` // npm's newest, when it answered
	// Status is "update" (npm has a newer version), "current", "unknown"
	// (npm didn't say: Why and Error say why), or "folder" for one that
	// has no versions to ask about. For a plugin from a git repository it
	// is its repository's answer: "update" when it is at another commit
	// than Commit (Head), "current", "unknown" (it didn't say), or "git"
	// when no commit can be compared (bun named none it installed).
	Status string `json:"status"`
	// Commit and Head are a git one's commit installed and its
	// repository's now, as the page shows them
	Commit string `json:"commit,omitempty"`
	Head   string `json:"head,omitempty"`
	// Why is why npm didn't say: "offline" (not reached), "limited" (too
	// many requests), "registry" (it answered with an error) or "missing"
	// (it has no such package)
	Why   string `json:"why,omitempty"`
	Error string `json:"error,omitempty"`
	// Limited is set when a git one's repository couldn't be asked
	// because GitHub's rate limit was used up, for the page to say so in
	// its own words, as the library's skills do (#1942)
	Limited *GitHubLimit `json:"limited,omitempty"`
	// Auto is whether magpie updates it by itself (the community's,
	// unpinned, switched on), so an update found would come anyway
	Auto bool `json:"auto"`
	Off  bool `json:"off"`
}

VersionCheck is what asking npm now found of one installed plugin.

type VersionChecks added in v0.1.663 

type VersionChecks struct {
	At      time.Time      `json:"at"`
	Plugins []VersionCheck `json:"plugins"`
}

VersionChecks is what a check asked now found.

func CheckNow added in v0.1.663 

func CheckNow(ctx context.Context) VersionChecks

CheckNow asks npm now, not what it said within the hour, for the newest version of each installed plugin, for the reader's Check for updates. Nothing is installed: what it finds is updated as any update is, with Upgrade. What npm says is kept, as Info keeps it, and the updates found for the reader (someone else's, or pinned) wait for them as the background look's do, putting the dot on Plugins.

type Waiting added in v0.1.573 

type Waiting struct {
	Spec    string `json:"spec"`
	Package string `json:"package"`
	Version string `json:"version"`
	Latest  string `json:"latest"`
	Git     bool   `json:"git,omitempty"`
}

Waiting is a plugin with a newer version on npm than the one installed, or, for one from a git repository (Git), whose repository is at another commit than the one installed: Version and Latest are then the two commits.

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.