Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pedro-hs/checkbox.sh

Interactive checkboxes (menu) with pagination and vim keybinds for bash
https://github.com/pedro-hs/checkbox.sh

bash bash-script checkbox interactive-checkboxes pagination shell-script terminal tui vim vim-keybinds

Last synced: 4 days ago
JSON representation

Interactive checkboxes (menu) with pagination and vim keybinds for bash

Host: GitHub
URL: https://github.com/pedro-hs/checkbox.sh
Owner: pedro-hs
License: mit
Created: 2020-10-03T08:00:48.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2024-03-02T05:45:26.000Z (8 months ago)
Last Synced: 2024-08-01T12:28:14.174Z (3 months ago)
Topics: bash, bash-script, checkbox, interactive-checkboxes, pagination, shell-script, terminal, tui, vim, vim-keybinds
Language: Shell
Homepage: https://github.com/pedro-hs/checkbox.sh
Size: 1.68 MB
Stars: 49
Watchers: 2
Forks: 13
Open Issues: 12
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        ## ⌨️ checkbox.sh

[![Bash](https://img.shields.io/badge/language-Bash-green.svg)](https://github.com/pedro-hs/checkbox.sh/blob/master/checkbox.sh) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/pedro-hs/terminal-checkbox.sh/master/LICENSE.md)

Interactive checkboxes (menu) with pagination and vim keybinds for bash

![](example/demo.gif)





### Table of Contents

- [ Features ](#features)

- [ Quick Start ](#quick-start)

- [ Promotion ](#promotion)

- [ Arguments Usage ](#arguments-usage)

- [ How to use with another script ](#how-to-use-with-another-script)

- [ Keybinds Usage ](#keybinds-usage)

- [ Limitations ](#limitations)







### Features

- Select only a option or multiple options

- Select or unselect multiple options easily

- Select all or unselect all

- Pagination

- Optional Vim keybinds

- A .sh file with approximately 500 lines

- Start with options selected

- Show selected options counter for multiple options

- Show custom message

- Show current option index and options amount

- Copy current option value to clipboard

- Help tab when press h or wrongly call the script




### Quick Start

Run the script (in bash shell) with `source checkbox.sh`




### Promotion

⭐ If you like this software, give a star ⭐

📖 Contributions are welcome 📖




### Arguments Usage

##### Checkbox options

Use the argument `--options=""`




You can add new options:

- With the character `|`

- With new line

- Mixed

![](example/options/options_mixed.gif)




To start with options selected, put `+` before the option text (in first character)

- If the argument --multiple is missing, just the first option marked with + will start selected

![](example/options/options_start_seleted.gif)




Any of this ASCII signs `\a \b \f \n \r \t` in any part of options will be removed.

![](example/options/options_ascii.gif)




If --options"" is missing. Sample options will be loaded with 30 options.

![](example/options/no_options.gif)




---

##### Show message on header

Use the argument `--message=""`

![](example/message.gif)

You can customize message

- Using ANSI 


  Example: `--message="\033[2K\033[31mhello world"`

  



- Using ASCII `\a \b \e \f \n \r \t \v` 


  Example: `--message="hello\rworld"`

- Maybe the layout breaks, in this case, try to refresh (press `r`)




---

##### Select multiple options

Use the argument `--multiple`

![](example/multiple.gif)




---

##### Return index instead of values

Use the argument `--index`

![](example/index.gif)







### How to use with another script

You can get the script response in the variable $checkbox_output after execute the script

- Example:

```

#!/usr/bin/env bash

source checkbox.sh --multiple --index

clear

selected_options="$checkbox_output"

echo "$selected_options"

```

- Other example: https://github.com/pedro-hs/git-selection







### Keybinds Usage

##### Move arround

Press `[UP ARROW]` or `'k'` to move cursor to option above

Press `[UP DOWN]` or `'j'` to move cursor to option below

Press `[PAGE UP]` or `'d'` to move cursor 5 options above

Press `[PAGE DOWN]` or `'u'` to move cursor 5 options below

Press `[HOME]` or `'g'` to move cursor to first option

Press `[END]` or `'G'` to move cursor to last option




---

##### Select current option

Press `[SPACE]` or `x`




##### Close and return selected options

Press `[ENTER]` or `'o'`




##### Copy current option

Press `'c'` or `'y'`




##### Select or Unselect All (only with --multiple)

Press `'a'` to select all and `'A'` to unselect all




##### Select or Unselect Mode (only with --multiple)

Press `'v'` to turn on/off select mode `'V'` to turn on/off unselect mode

![](example/select_unselect.gif)

- If select mode is on. Cursor will be green and when you move up or down the options will be selected

- If unselect mode is on. Cursor will be red and when you move up or down the options will be unselected




---

##### Refresh

Press `'r'` to refresh renderization

![](example/refresh.gif)




---

##### Help

Press `'h'` or call script with invalid argument, and a help page will appear

![](example/help.gif)







### Limitations

- Doesn't have a good compatibility with mac, I will work on this in future

- Uses bash array, so bash or similars are needed to run this script

- Terminal must have at least 8 lines for the script works. Maybe breaks in some cases with --message too. Resize terminal and press 'r'

- Don't have unit test