hush

README

hush

A simple Bourne-like shell, compatible with Wasm. Written in Go.

Getting started

Install like any other go library:

go install github.com/btwiuse/hush/cmd/hush@latest

Alternatively, import hush in your own projects:

package main

import (
    "os"
    "github.com/btwiuse/hush"
)

func main() {
    exitCode := hush.Run()
    os.Exit(exitCode)
}

Wasm compatibility

Today, Go's Web Assembly support does not include running processes. To make this possible, Hush is built with hackpad's go fork. The fork contains patches that spawn and manage processes using Node.js's APIs, similar to the Node.js file system API used upstream.

Documentation

Index

• Variables
• func NewRunner(term *Console) *interp.Runner
• func Run() int
• func RunSimple() int
• type Console

Variables

var ProgramOptions = []tea.ProgramOption{}

Functions

func NewRunner

func NewRunner(term *Console) *interp.Runner

Run runs the hush shell NewRunner creates an interp.Runner with all hush builtins and middleware.

func Run

func Run() int

func RunSimple

func RunSimple() int

RunSimple runs hush with the standard parser-driven prompt instead of bubbline's readline interface.

Types

type Console

type Console struct {
	Stdin          io.Reader
	Stdout, Stderr io.Writer
}

Console carries the I/O streams for builtin commands.