https://github.com/rail5/bashpp
Bash++: Bash with classes
https://github.com/rail5/bashpp
bash classes-and-objects object-oriented-programming shell
Last synced: 17 days ago
JSON representation
Bash++: Bash with classes
- Host: GitHub
- URL: https://github.com/rail5/bashpp
- Owner: rail5
- License: gpl-3.0
- Created: 2024-10-22T03:11:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-02-11T05:16:56.000Z (21 days ago)
- Last Synced: 2026-02-11T11:37:10.902Z (21 days ago)
- Topics: bash, classes-and-objects, object-oriented-programming, shell
- Language: C++
- Homepage: https://bpp.sh/
- Size: 3.52 MB
- Stars: 42
- Watchers: 3
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Bash++
```java
@class Bashpp {
@public author="Andrew S. Rightenburg"
@public source="https://github.com/rail5/bashpp"
@public license="GNU GPL v3"
@public @method printInfo {
echo "Bash++ is a superset of Bash that adds support for classes and objects."
echo "It's designed to be a simple way to add object-orientation to Bash scripts."
echo "Author: @this.author"
echo "Source: @this.source"
echo "License: @this.license"
}
}
@Bashpp myBashpp
@myBashpp.printInfo
```
More documentation is available on the [website](https://bpp.sh).
The Bash++ language and compiler are licensed under the GNU General Public License v3 or later (GPL-3.0-or-later).
This does not affect any code you write in Bash++ – only the Bash++ language and compiler themselves. You are perfectly free to use Bash++ to write software under a different license.
## Installation
> [!IMPORTANT]
> The Bash++ compiler is currently in *beta*, and is expected to have bugs. Please report any bugs you find to the [issue tracker](https://github.com/rail5/bashpp/issues).
>
### Debian GNU/Linux
Users of Debian-based distributions can install the compiler from the [deb.rail5.org](https://deb.rail5.org) repository.
```shell
sudo curl -s -o /etc/apt/trusted.gpg.d/rail5-signing-key.gpg "https://deb.rail5.org/rail5-signing-key.gpg"
sudo curl -s -o /etc/apt/sources.list.d/rail5.list "https://deb.rail5.org/rail5.list"
sudo apt update
sudo apt install bpp
```
Pre-built packages are available for **amd64** and **arm64**. The .debs can also be downloaded directly from the [GitHub releases page](https://github.com/rail5/bashpp/releases/latest)
### Building from source
#### Prerequisites
- `bash`
- `make`
- `g++`
- `flex`
- `bison`
- `libutfcpp-dev`
Language server-specific prerequisites:
- `nlohmann-json3-dev`
- `libfrozen-dev`
Optional:
- `pandoc` and `perl` for building the documentation
- `debhelper` for building the Debian package and keeping version numbers up-to-date via `dpkg-parsechangelog`
On Debian-based systems, you can install the prerequisites with:
```bash
$ sudo apt update
$ sudo apt install build-essential flex bison libutfcpp-dev libfrozen-dev pandoc perl debhelper nlohmann-json3-dev
```
#### Building
```bash
$ make # Build the Bash++ compiler and language server, bin/bpp and bin/bpp-lsp
$ make manual # Build the manpages, which can then be found under debian/
$ make test # Run the test suite to verify the compiler works correctly
```
## Using the compiler
```bash
$ bpp program.bpp # Compile & immediately run the program
$ bpp -o compiled.sh program.bpp # Compile & save the program to compiled.sh
$ bpp -o - program.bpp # Compile & print the program to stdout
$ cat program.bpp | bpp # Pipe previous command output to the compiler
$ bpp -h # Display help
$ bpp -v # Display version
```
Any arguments given *after* the input file will be passed to the compiled program.
## Debugging
If you encounter a bug, please report it to the [issue tracker](https://github.com/rail5/bashpp/issues).
If you'd like to debug the compiler yourself, you can use the compiler with the `-tp` flags. Using `-t` will print lexer output, and using `-p` will print the parse tree for an input file. This can be useful for debugging syntax errors and compiler issues.
```bash
$ bpp -tp program.bpp
```
[Shellwatch](https://github.com/rail5/shellwatch) is a tool designed specifically to help debug Bash++ programs and compiler issues. Shellwatch will step a Bash script line-by-line, showing the current state of variables and their values, as well as the current line of the script being executed. Shellwatch will also allow you to modify the values of stored variables before continuing script execution. This tool can be very helpful for debugging complex (compiled) Bash++ programs which are hard to analyze with your eyes alone.
```bash
$ shellwatch compiled-program.sh
```
## VSCode extension
The [Bash++ extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=rail5.bashpp) provides IDE language support for Bash++, including syntax highlighting and (optionally) language server features such as code completion, go-to definition, etc.