indexoperations

Documentation

Index

• func AddIndex(paths environment.Paths, name, url string) error
• func DeleteIndex(paths environment.Paths, name string) error
• func IsValidIndexName(name string) bool
• type Index
  • func ListIndexes(paths environment.Paths) ([]Index, error)

Functions

func AddIndex

func AddIndex(paths environment.Paths, name, url string) error

AddIndex initializes a new index to install plugins from.

func DeleteIndex

func DeleteIndex(paths environment.Paths, name string) error

DeleteIndex removes specified index name. If index does not exist, returns an error that can be tested by os.IsNotExist.

func IsValidIndexName

func IsValidIndexName(name string) bool

IsValidIndexName validates if an index name contains invalid characters

Types

type Index

type Index struct {
	Name string
	URL  string
}

Index describes the name and URL of a configured index.

func ListIndexes

func ListIndexes(paths environment.Paths) ([]Index, error)

ListIndexes returns a slice of Index objects. The path argument is used as the base path of the index.