cli

Documentation

Overview

Package cli makes reusable the core parts of the squircy command.

Index

• func CoreFlags(fs *flag.FlagSet, root string)
• func DefaultFlags(fs *flag.FlagSet)
• func IRCFlags(fs *flag.FlagSet)
• func PluginOptsFlag(fs *flag.FlagSet, name, usage string)
• func PluginOptsFlagVar(fs *flag.FlagSet, val flag.Value, name, usage string)
• func VMFlags(fs *flag.FlagSet)
• type Config
• type Manager
  • func NewManager() (*Manager, error)
  • func (manager *Manager) Loop() error
  • func (manager *Manager) Plugins() *plugin.Manager
  • func (manager *Manager) Shutdown() error
  • func (manager *Manager) Start() error
  • func (manager *Manager) Stop()

Functions

func CoreFlags

func CoreFlags(fs *flag.FlagSet, root string)

func DefaultFlags

func DefaultFlags(fs *flag.FlagSet)

func IRCFlags

func IRCFlags(fs *flag.FlagSet)

func PluginOptsFlag

func PluginOptsFlag(fs *flag.FlagSet, name, usage string)

func PluginOptsFlagVar

func PluginOptsFlagVar(fs *flag.FlagSet, val flag.Value, name, usage string)

func VMFlags

func VMFlags(fs *flag.FlagSet)

Types

type Config

type Config struct {
	RootDir      string   `toml:"root_path" flag:"root"`
	PluginDir    string   `toml:"plugin_path"`
	ExtraPlugins []string `toml:"extra_plugins" flag:"plugin"`

	PluginOptions map[string]interface{} `flag:"plugin_option"`

	LogLevel logrus.Level `toml:"log_level"`

	// Specify additional plugins that are a part of the main executable.
	LinkedPlugins []plugin.Initializer
}

type Manager

type Manager struct {
	Config
	// contains filtered or unexported fields
}

func NewManager

func NewManager() (*Manager, error)

func (*Manager) Loop

func (manager *Manager) Loop() error

func (*Manager) Plugins

func (manager *Manager) Plugins() *plugin.Manager

func (*Manager) Shutdown

func (manager *Manager) Shutdown() error

func (*Manager) Start

func (manager *Manager) Start() error

func (*Manager) Stop

func (manager *Manager) Stop()