# ble.sh
**Repository Path**: macd11/ble.sh
## Basic Information
- **Project Name**: ble.sh
- **Description**: Bash 线编辑器 (ble.sh†1）是一个用纯 Bash 编写的命令行编辑器†2它取代了默认的 GNU Readline。
当前的开发版本是 0.4。 此脚本支持 Bash 3.0 或更高版本，但我们建议与 Bash 4.0 或更高版本一起使用。 还需要 POSIX 标准实用程序。 目前，仅支持非 ASCII 字符的编码。
- **Primary Language**: Shell
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-09-02
- **Last Updated**: 2025-09-02
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
[ Languages: **English** | [日本語](README-ja_JP.md) (Japanese) ]
ble.sh ―Bash Line Editor―
[ README | Manual |
Q&A |
contrib |
Recipes ]
*Bash Line Editor* (`ble.sh`†1) is a command line editor written in pure Bash†2 which replaces the default GNU Readline.
The current devel version is 0.4.
This script supports Bash 3.0 or higher although we recommend using `ble.sh` with release versions of **Bash 4.0 or higher**.
The POSIX standard utilities are also required.
Currently, only `UTF-8` encoding is supported for non-ASCII characters.
This script is provided under the [**BSD License**](LICENSE.md) (3-clause BSD license).
## Quick instructions
There are two ways to get `ble.sh`: to get the source using `git` and build
`ble.sh`, or to download the [nightly build](https://github.com/akinomyoga/ble.sh/releases/tag/nightly) using `curl` or `wget`.
See [Sec 1.1](#get-from-source) and [Sec 1.2](#get-from-tarball) for the details of trial and installation.
See [Sec 1.3](#set-up-bashrc) for the details of the setup of your `~/.bashrc`.
> [!NOTE]
> If you want to **use fzf with `ble.sh`**, you need to check [Sec
> 2.8](#fzf-integration).
Download source using git and make ble.sh
This requires the commands `git`, `make` (GNU make), and `gawk` (GNU awk)†3.
In the following, please replace `make` with `gmake` if your system provides GNU make as `gmake` (such as in BSD).
```bash
# TRIAL without installation
git clone --recursive --depth 1 --shallow-submodules https://github.com/akinomyoga/ble.sh.git
make -C ble.sh
source ble.sh/out/ble.sh
# Quick INSTALL to BASHRC (If this doesn't work, please follow Sec 1.3)
git clone --recursive --depth 1 --shallow-submodules https://github.com/akinomyoga/ble.sh.git
make -C ble.sh install PREFIX=~/.local
echo 'source -- ~/.local/share/blesh/ble.sh' >> ~/.bashrc
```
The build process integrates multiple Bash script files into a single Bash script `ble.sh` with pre-processing.
It also places other module files in appropriate places and strips code comments for a shorter initialization time.
The build process does not involve any C/C++/Fortran compilations and generating binaries, so C/C++/Fortran compilers are not needed.
Download the nightly build with curl
This requires the commands `curl`, `tar` (with the support for the `J` flag), and `xz` (XZ Utils).
```bash
# TRIAL without installation
curl -L https://github.com/akinomyoga/ble.sh/releases/download/nightly/ble-nightly.tar.xz | tar xJf -
source ble-nightly/ble.sh
# Quick INSTALL to BASHRC (If this doesn't work, please follow Sec 1.3)
curl -L https://github.com/akinomyoga/ble.sh/releases/download/nightly/ble-nightly.tar.xz | tar xJf -
bash ble-nightly/ble.sh --install ~/.local/share
echo 'source -- ~/.local/share/blesh/ble.sh' >> ~/.bashrc
```
After the installation, the directory `ble-nightly` can be removed.
Download the nightly build with wget
This requires the commands `wget`, `tar` (with the support for the `J` flag), and `xz` (XZ Utils).
```bash
# TRIAL without installation
wget -O - https://github.com/akinomyoga/ble.sh/releases/download/nightly/ble-nightly.tar.xz | tar xJf -
source ble-nightly/ble.sh
# Quick INSTALL to BASHRC (If this doesn't work, please follow Sec 1.3)
wget -O - https://github.com/akinomyoga/ble.sh/releases/download/nightly/ble-nightly.tar.xz | tar xJf -
bash ble-nightly/ble.sh --install ~/.local/share
echo 'source -- ~/.local/share/blesh/ble.sh' >> ~/.bashrc
```
After the installation, the directory `ble-nightly` can be removed.
Install a package using a package manager (currently only a few packages)
This only requires the corresponding package manager.
- [AUR (Arch Linux)](https://github.com/akinomyoga/ble.sh/wiki/Manual-A1-Installation#user-content-AUR) `blesh-git` (devel), `blesh` (stable 0.3.4)
- [NixOS (nixpkgs)](https://github.com/akinomyoga/ble.sh/wiki/Manual-A1-Installation#user-content-nixpkgs) `blesh` (devel)
- [Guix](https://packages.guix.gnu.org/packages/blesh) `blesh` (devel)
Update an existing copy of ble.sh
```bash
# UPDATE (in a ble.sh session)
ble-update
# UPDATE (outside ble.sh sessions)
bash /path/to/ble.sh --update
```
Create a package of ble.sh
Since `ble.sh` is just a set of shell scripts and do not contain any binary (i.e., "`noarch`"),
you may just download the pre-built tarball from a release page and put the extracted contents in e.g. `/tmp/blesh-package/usr/local`.
Nevertheless, if you need to build the package from the source, please use the following commands.
Note that the git repository (`.git`) is required for the build.
```bash
# BUILD & PACKAGE (for package maintainers)
git clone --recursive https://github.com/akinomyoga/ble.sh.git
make -C ble.sh install DESTDIR=/tmp/blesh-package PREFIX=/usr/local
```
For a detailed control of the install locations of the main files, the license
files, and the documentation files, please also check the later sections
[Install](#install) and [Package](#package).
If you want to tell `ble.sh` the way to update the package for `ble-update`,
you can place `_package.bash` at `${prefix}/share/blesh/lib/_package.bash`.
Please check [`_package.bash`](#_packagebash) for the details.
```bash
# ${prefix}/share/blesh/lib/_package.bash
_ble_base_package_type=XXX
function ble/base/package:XXX/update {
update-the-package-in-a-proper-way
}
```