shim

package
v0.1.16 Latest Latest
Warning

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

Go to latest
Published: Mar 1, 2026 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrInvalidServerName = errors.New("invalid shim server name")
	ErrPathOccupied      = errors.New("shim path already exists")
	ErrCommandCollision  = errors.New("command already exists in PATH")
	ErrNotInstalled      = errors.New("shim is not installed")
	ErrNotManagedShim    = errors.New("shim path is not managed by mcpx")
)

Functions

func DefaultDir

func DefaultDir() string

DefaultDir returns the default install location for shims.

Types

type Entry

type Entry struct {
	Dir    string
	Path   string
	Server string
}

func List

func List(opts ListOptions) ([]Entry, error)

type InstallOptions

type InstallOptions struct {
	Dir string
}

type InstallResult

type InstallResult struct {
	Dir              string
	Path             string
	Server           string
	AlreadyInstalled bool
	DirInPath        bool
}

func Install

func Install(server string, opts InstallOptions) (*InstallResult, error)

type ListOptions

type ListOptions struct {
	Dir string
}

type RemoveOptions

type RemoveOptions struct {
	Dir string
}

type RemoveResult

type RemoveResult struct {
	Dir    string
	Path   string
	Server string
}

func Remove

func Remove(server string, opts RemoveOptions) (*RemoveResult, error)

Jump to

Keyboard shortcuts

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