plugins

Documentation

Index

• type Command
• type Commands
• type List
  • func Available() (List, error)

Types

type Command

type Command struct {
	// Name "foo"
	Name string `json:"name"`
	// BuffaloCommand "generate"
	BuffaloCommand string `json:"buffalo_command"`
	// Description "generates a foo"
	Description string   `json:"description"`
	Aliases     []string `json:"aliases"`
	Binary      string   `json:"-"`
}

Command that the plugin supplies

type Commands

type Commands []Command

Commands is a slice of Command

type List

type List map[string]Commands

List maps a Buffalo command to a slice of Command

func Available

func Available() (List, error)

Available plugins for the `buffalo` command. It will look in $PATH and the `./plugins` directory.

Requirements:

• file/command must be executable
• file/command must start with `buffalo-`
• file/command must respond to `available` and return JSON of plugins.Commands{}

Caveats: * The C:\Windows directory is excluded