https://github.com/nyaosorg/go-box

go-box - interactive item selector for the terminal
https://github.com/nyaosorg/go-box

command-line freebsd go golang prompt windows

Last synced: about 2 months ago
JSON representation

go-box - interactive item selector for the terminal

• Host: GitHub
• URL: https://github.com/nyaosorg/go-box
• Owner: nyaosorg
• License: bsd-3-clause
• Created: 2017-03-27T16:56:28.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2026-02-09T15:24:58.000Z (5 months ago)
• Last Synced: 2026-02-09T15:44:36.940Z (5 months ago)
• Topics: command-line, freebsd, go, golang, prompt, windows
• Language: Go
• Homepage: https://pkg.go.dev/github.com/nyaosorg/go-box/v3
• Size: 133 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Go-Box - Interactive item selector

==================================

[![Go Test](https://github.com/nyaosorg/go-box/actions/workflows/go.yml/badge.svg)](https://github.com/nyaosorg/go-box/actions/workflows/go.yml)

[![License](https://img.shields.io/badge/License-MIT-red)](https://github.com/nyaosorg/go-box/v3/blob/master/LICENSE)

[![Go Reference](https://pkg.go.dev/badge/github.com/nyaosorg/go-box/v3.svg)](https://pkg.go.dev/github.com/nyaosorg/go-box/v3)

> **Note:** This is the documentation for **go-box v3**.  

> If your code still imports `github.com/nyaosorg/go-box` or `/v2`,  

> please update the import path to `github.com/nyaosorg/go-box/v3`.

box - Executable

----------------

`box` is a command-line program built with the **go-box** library.  

It reads a list of items from STDIN and lets the user select one interactively.

![demo](./demo.gif)

### Install

Download the binary package from [Releases](https://github.com/nyaosorg/go-box/releases) and extract the executable.

#### Use "go install"

```

go install github.com/nyaosorg/go-box/v3/cmd/box@latest

```

#### Use "scoop-installer"

```

scoop install https://raw.githubusercontent.com/nyaosorg/go-box/master/box.json

```

or

```

scoop bucket add hymkor https://github.com/hymkor/scoop-bucket

scoop install box

```

go-box - golang package

-----------------------

```examples/yesno.go

package main

import (

    "os"

    "github.com/nyaosorg/go-box/v3"

)

func main() {

    println("Are you sure ?")

    choose, err := box.SelectString([]string{"Yes", "No"}, false, os.Stderr)

    if err != nil {

        println(err.Error())

        os.Exit(1)

    }

    println()

    if len(choose) >= 1 {

        println("You selected ->", choose[0])

    } else {

        println("You did not select any items")

    }

}

```

Release notes

-------------

- [English](release_note.md)

- [Japanese](release_note_ja.md)