https://github.com/wobsoriano/bun-promptx

Terminal prompt library for the Bun runtime
https://github.com/wobsoriano/bun-promptx

bun bunjs cli go prompt tui

Last synced: about 1 month ago
JSON representation

Terminal prompt library for the Bun runtime

• Host: GitHub
• URL: https://github.com/wobsoriano/bun-promptx
• Owner: wobsoriano
• License: mit
• Created: 2022-07-19T21:57:45.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-19T03:54:01.000Z (9 months ago)
• Last Synced: 2024-05-02T22:08:56.469Z (about 1 month ago)
• Topics: bun, bunjs, cli, go, prompt, tui
• Language: Go
• Homepage:
• Size: 107 KB
• Stars: 77
• Watchers: 4
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-bun - bun-promptx - Terminal prompt library based on bubbles via bun:ffi. (Extensions / Utilities)
• my-awesome-stars - wobsoriano/bun-promptx - Terminal prompt library for the Bun runtime (Go)
• awesome-stars - wobsoriano/bun-promptx - Terminal prompt library for the Bun runtime (tui)

README

        
# bun-promptx

bun-promptx is a terminal prompt library based on [bubbles](https://github.com/mritd/bubbles) via `bun:ffi`.

## Install

```bash

bun add bun-promptx

```

## Usage

### createSelection

The `createSelection` function lets you create a terminal single-selection list prompt. It provides the functions of page up and down and key movement, and supports custom rendering methods.

```js

import { createSelection } from 'bun-promptx'

const result = createSelection([

  { text: 'feat', description: 'Introducing new features' },

  { text: 'fix', description: 'Bug fix' },

  { text: 'docs', description: 'Writing docs' },

  { text: 'style', description: 'Improving structure/format of the code' },

  { text: 'refactor', description: 'Refactoring code' },

  { text: 'test', description: 'Refactoring code' },

  { text: 'chore', description: 'When adding missing tests' },

  { text: 'perf', description: 'Improving performance' }

], {

  headerText: 'Select Commit Type: ',

  perPage: 5,

  footerText: 'Footer here'

})

console.log(result)

// { selectedIndex: 2, error: null }

```



### createPrompt

The `createPrompt` function is a terminal input prompt library. It provides CJK character support and standard terminal shortcut keys (such as ctrl+a, ctrl+e), password input echo and other functions.

```js

import { createPrompt } from 'bun-promptx'

const username = createPrompt("Enter username: ")

// { value: "wobsoriano", error: null }

const password = createPrompt("Enter password: ", {

  echoMode: 'password'

})

// { value: "123456", error: null }

```



## License

MIT