Skip to content
/ goline Public

A simple readline facility for Go. Based on the C library Linenoise

Notifications You must be signed in to change notification settings

nemith/goline

Repository files navigation

goline

Build Status

Simple implemenation of a readline like facility that is heavly based on the C library linenoise. Uses syscalls directly from Golang to implment the low level terminal functions and doesn't wrap any existing C library. BSD and Linux support currently. No Windows support.

Currently only does simple line editing. Upcoming versions will include:

  • Completion

Very alpha quality right now. API will probably change and evolve.

Sample

package main

import (
	"fmt"
	"github.com/nemith/goline"
)

func helpHandler(l *goline.GoLine) (bool, error) {
	fmt.Println("\nHelp!")
	return false, nil
}

func main() {
	gl := goline.NewGoLine(goline.StringPrompt("prompt> "))

	gl.AddHandler('?', helpHandler)

	for {
		data, err := gl.Line()
		if err != nil {
			if err == goline.UserTerminatedError {
				fmt.Println("\nUser terminated.")
				return
			} else {
				panic(err)
			}
		}

		fmt.Printf("\nGot: '%s' (%d)\n", data, len(data))

		if data == "exit" || data == "quit" {
			fmt.Println("Exiting.")
			return
		}

	}
}

Documentation

Latest documentation can always be found at http://godoc.org/github.com/nemith/goline

Install

go get github.com/nemith/goline

License

(BSD 2)

Copyright © 2013, Brandon Bennett

Linenoise copyrights:
Copyright (c) 2010-2013, Salvatore Sanfilippo <antirez at gmail dot com>
Copyright (c) 2010-2013, Pieter Noordhuis <pcnoordhuis at gmail dot com>

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

(1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

(2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied.

Authors and Contributors

About

A simple readline facility for Go. Based on the C library Linenoise

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages