cli

Documentation

Index

• type CLI
  • func NewCLI() (*CLI, error)
  • func (c CLI) GitRoot() (string, error)
  • func (c CLI) Hook() error
  • func (c CLI) Init() error
  • func (c CLI) List() error
  • func (c CLI) ListPath() (string, error)
  • func (c CLI) RemoveHook() error
  • func (c CLI) Run(hookPath string) error
  • func (c CLI) RunCopy() error
  • func (c CLI) Wget(src, dst string) (err error)

Types

type CLI

type CLI struct {
}

CLI represents this application itself.

func NewCLI

func NewCLI() (*CLI, error)

NewCLI returns a new CLI.

func (CLI) GitRoot

func (c CLI) GitRoot() (string, error)

GitRoot returns the path to the git root directory.

func (CLI) Hook

func (c CLI) Hook() error

Hook sets the commit hook.

func (CLI) Init

func (c CLI) Init() error

Init downloads the list of gmojis.

func (CLI) List

func (c CLI) List() error

List prints the list of gmojis.

func (CLI) ListPath

func (c CLI) ListPath() (string, error)

ListPath returns the path to the gitmojis.json file.

func (CLI) RemoveHook

func (c CLI) RemoveHook() error

RemoveHook removes the commit hook.

func (CLI) Run

func (c CLI) Run(hookPath string) error

Run runs CLI.

func (CLI) RunCopy

func (c CLI) RunCopy() error

RunCopy runs CLI and copy the commit message to the clipboard.

func (CLI) Wget

func (c CLI) Wget(src, dst string) (err error)

Wget downloads a file from the given URL.