https://github.com/ivanbgd/ilsh
`ilsh` - A POSIX-Compliant Shell (CLI) Implementation in Rust
https://github.com/ivanbgd/ilsh
finite-state-machine fsm ilsh parser posix posix-compliant posix-sh posix-shell rust rust-lang state-machine
Last synced: 7 days ago
JSON representation
`ilsh` - A POSIX-Compliant Shell (CLI) Implementation in Rust
- Host: GitHub
- URL: https://github.com/ivanbgd/ilsh
- Owner: ivanbgd
- License: mit
- Created: 2025-05-29T22:15:33.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-12-18T17:29:23.000Z (6 months ago)
- Last Synced: 2026-05-27T03:33:14.421Z (29 days ago)
- Topics: finite-state-machine, fsm, ilsh, parser, posix, posix-compliant, posix-sh, posix-shell, rust, rust-lang, state-machine
- Language: Rust
- Homepage:
- Size: 154 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# `ilsh` - A POSIX-Compliant Shell (CLI) Implementation in Rust
[](LICENSE)
[](https://crates.io/crates/ilsh)
[](https://docs.rs/ilsh/)
[](https://github.com/ivanbgd/ilsh/actions/workflows/ci.yml)
[](https://github.com/ivanbgd/ilsh/actions/workflows/audit.yml)
[](https://github.com/pre-commit/pre-commit)
# Supported Builtin Commands
- [cd](https://pubs.opengroup.org/onlinepubs/9699919799/utilities/cd.html) - change the working directory
- [echo [string...]](https://pubs.opengroup.org/onlinepubs/9699919799/utilities/echo.html) - write arguments to standard
output
- [exit [n]](https://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#exit) - cause the shell to exit
- [pwd](https://pubs.opengroup.org/onlinepubs/9699919799/utilities/pwd.html) - return working directory name
- [type [type name...]](https://pubs.opengroup.org/onlinepubs/9699919799/utilities/type.html) - write a description of
command type
# Notes
- Mostly [bash](https://www.gnu.org/software/bash/) is used as a reference, but not everything is in accordance
with `bash`.
- Supports running external programs with arguments.
- External programs are located using the [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) environment
variable.
- Supports [single quotes](https://www.gnu.org/software/bash/manual/bash.html#Single-Quotes).
- Supports [double quotes](https://www.gnu.org/software/bash/manual/bash.html#Double-Quotes).
- Supports [escape character](https://www.gnu.org/software/bash/manual/bash.html#Escape-Character) outside quotes.
- Supports [redirecting output](https://www.gnu.org/software/bash/manual/bash.html#Redirecting-Output).
- Supports
[appending redirected output](https://www.gnu.org/software/bash/manual/bash.html#Appending-Redirected-Output).
- Supports shell-specific `&>word` and shell-specific `>&word`, which redirect both `stdout` and `stderr` to the file
whose name is the expansion of `word`.
- Supports multiple redirections.
# Security
- [cargo audit](https://github.com/rustsec/rustsec/blob/main/cargo-audit/README.md) is supported,
as well as its GitHub action, [audit-check](https://github.com/rustsec/audit-check).
- [cargo deny](https://embarkstudios.github.io/cargo-deny/) is supported,
as well as its GitHub action, [cargo-deny-action](https://github.com/EmbarkStudios/cargo-deny-action).
# Development
## Pre-commit
[pre-commit](https://pre-commit.com/) hooks are supported.
```shell
$ pip install pre-commit # If you don't already have pre-commit installed on your machine. Run once.
$ pre-commit autoupdate # Update hook repositories to the latest versions.
$ pre-commit install # Sets up the pre-commit git hook script for the repository. Run once.
$ pre-commit install --hook-type pre-push # Sets up the pre-push git hook script for the repository. Run once.
$ pre-commit run # For manual running; considers only modified files.
$ pre-commit run --all-files # For manual running; considers all files.
```
After installing it, the provided [pre-commit hook(s)](.pre-commit-config.yaml) will run automatically on `git commit`.
# Running the Program
```shell
cargo run --release
```
```shell
export DEBUG=false
cargo run --release
```
A run script is provided.
The run script can set the `DEBUG` environment variable to `false` or `true`.
```shell
./run.sh
```
# Building and Running the Program with Debug Output
The program supports debugging output, which can be enabled by setting
the environment variable `DEBUG` to the value `true`.
It can be set outside the program, in the user shell, or inside the `run.sh` shell script.
This is only considered during **compile time**, and **not** during run time.
```shell
DEBUG=true ./run.sh
```
```shell
export DEBUG=true
./run.sh
```
# Testing
- Unit-test with `cargo test`.
- End-to-end-test with `./test.sh`.