gore

README

gore

Yet another Go REPL that works nicely. Featured with line editing, code completion, and more.

(Screencast taken with cho45/KeyCast)

Usage

gore

After a prompt is shown, enter any Go expressions/statements/functions or commands described below.

To quit the session, type Ctrl-D or use :q command.

Features

• Line editing with history
• Multi-line input
• Package importing with completion
• Evaluates any expressions, statements and function declarations
• No "evaluated but not used" errors
• Code completion (requires gocode)
• Showing documents
• Auto-importing (gore -autoimport)

REPL Commands

Some functionalities are provided as commands in the REPL:

:import <package path>  Import package
:type <expr>            Print the type of expression
:print                  Show current source
:write [<filename>]     Write out current source to file
:clear                  Clear the codes
:doc <expr or pkg>      Show document
:help                   List commands
:quit                   Quit the session

Supported Versions

Only the latest major version.

Installation

The gore command requires Go tool-chains on runtime, so standalone binary is not distributed.

go get github.com/motemen/gore/cmd/gore

Make sure $GOPATH/bin is in your $PATH.

Also recommended:

go get github.com/mdempsky/gocode   # for code completion

Or you can use Docker:

git clone https://github.com/motemen/gore.git
cd gore
docker build -t gore .
docker run -it --rm gore

FAQ/Caveats

• gore runs code using go run for each input. All the inputted lines are evaluated again and again so you can't bind the evaluated time by time.Now(), for example. If you don't like this behavior, you may want to use yaegi.
• gore support Go modules. You can load local modules when you start gore at the project directory. You don't need to go get to check the usage of a remote repository, :import github.com/... will automatically download that module. Also, you don't need to go get the pretty print module anymore. If you want to load a local code from $GOPATH, you need to create the modules file (go mod init ...) and then start gore at the project directory.

License

The MIT License.

Author

motemen <motemen@gmail.com>

Documentation

Index

• Constants
• type Error
  • func (e Error) Error() string
• type Gore
  • func New(opts ...Option) *Gore
  • func (g *Gore) Run() error
• type Option
  • func AutoImport(autoImport bool) Option
  • func ErrWriter(errWriter io.Writer) Option
  • func ExtFiles(extFiles string) Option
  • func OutWriter(outWriter io.Writer) Option
  • func PackageName(packageName string) Option
  • func Reader(reader io.Reader) Option
• type Session
  • func NewSession(stdout, stderr io.Writer, stdin io.Reader) (*Session, error)
  • func (s *Session) Clear() error
  • func (s *Session) Eval(in string) error
  • func (s *Session) Run() error

Constants

const Version = "0.5.2"

Version of gore.

Types

type Error

type Error string

Error ...

const (
	ErrContinue Error = "<continue input>"
	ErrQuit     Error = "<quit session>"
	ErrCmdRun   Error = "<command failed>"
)

Errors

func (Error) Error

func (e Error) Error() string

type Gore

type Gore struct {
	// contains filtered or unexported fields
}

Gore ...

func New

func New(opts ...Option) *Gore

New Gore

func (*Gore) Run

func (g *Gore) Run() error

Run ...

type Option

type Option func(*Gore)

Option for Gore

func AutoImport

func AutoImport(autoImport bool) Option

AutoImport option

func ErrWriter

func ErrWriter(errWriter io.Writer) Option

ErrWriter option

func ExtFiles

func ExtFiles(extFiles string) Option

ExtFiles option

func OutWriter

func OutWriter(outWriter io.Writer) Option

OutWriter option

func PackageName

func PackageName(packageName string) Option

PackageName option

func Reader

func Reader(reader io.Reader) Option

ErrWriter option

type Session

type Session struct {
	// contains filtered or unexported fields
}

Session ...

func NewSession

func NewSession(stdout, stderr io.Writer, stdin io.Reader) (*Session, error)

NewSession creates a new Session.

func (*Session) Clear

func (s *Session) Clear() error

Clear the temporary directory.

func (*Session) Eval

func (s *Session) Eval(in string) error

Eval the input.

func (*Session) Run

func (s *Session) Run() error

Run the session.