https://github.com/faraazahmad/shellrb
A unix-like shell built in Ruby
https://github.com/faraazahmad/shellrb
cross-platform linux macos ruby shell unix windows
Last synced: about 2 months ago
JSON representation
A unix-like shell built in Ruby
- Host: GitHub
- URL: https://github.com/faraazahmad/shellrb
- Owner: faraazahmad
- License: mit
- Created: 2017-02-10T13:52:34.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-10-22T13:04:25.000Z (over 2 years ago)
- Last Synced: 2023-10-22T14:21:22.693Z (over 2 years ago)
- Topics: cross-platform, linux, macos, ruby, shell, unix, windows
- Language: Ruby
- Homepage:
- Size: 110 KB
- Stars: 33
- Watchers: 7
- Forks: 23
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ShellRB - Unix shell commands using Ruby
[](https://travis-ci.org/faraazahmad/shellrb)
[](https://gitter.im/shellrb/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
ShellRB is a portable **(Windows / Linux / macOS)** implementation of Unix shell commands on top of the Ruby's modules. It is a command-line interface (CLI) toolkit written in Ruby, designed to simplify and improve your experience with interacting with command-line tools and processes. You can use it to eliminate your shell script's dependency on Unix, while still keeping its familiar and powerful commands.
Also, This toolkit provides a wide range of functionality, including command parsing, argument validation, option parsing, subcommand management, and more. It also provides a simple and intuitive way to create complex command-line interfaces for your Ruby applications. In this repository, you'll find all the necessary documentation, examples, and source code to install and use ShellRB.
Inspired from [ShellJS/Shx](https://github.com/shelljs/shx).
## Example
Here's a sneak peek at how it feels to use ShellRB:
```
faraaz@SRB: /home/faraaz> ls
foo
bar
shellrb
...
faraaz@SRB: /> cd home
faraaz@SRB: /home> cd faraaz
faraaz@SRB: /home/faraaz> pwd
/home/faraaz
```
## Why ShellRB
I've been using Linux for my development environment ever since I jumped onto the open-source bandwagon. Often, I've wondered, what would people do if they really wanted to use a Bash-like shell on Windows without the hassle of firing-up a Linux-based OS VM.
Enter ShellRB. The goal is to build a Bash-like shell in Ruby that runs cross-platform, is easy to maintain (has tests for every feature), and is friendly to new contributors.
## Installation
### Prerequisites
1. Make sure you have **Ruby** and **Git** installed (pretty obvious, right?).
On macOS, Ruby comes pre-installed, on Linux you can install it preferably using [RVM](https://rvm.io), and on Windows, you may have to install Git and Ruby using their installers from [here](https://git-scm.com/download/win) and [here](https://rubyinstaller.org/) respectively.
2. Once you have the above installed, you will also need to install the **`rake` gem**. You can install that using:
```
gem install rake
```
### Install ShellRB
1. Clone the repository using Git and `cd` into it:
```
git clone https://github.com/faraazahmad/shellrb.git
cd shellrb
```
2. Install the required gems:
```
rake install
```
ShellRB is now installed. You can now run it using:
```
rake run
```
## Updating the gems
To update the gems that ShellRB depends upon, just run:
```
rake update
```
## Updating ShellRB
To get the latest build of ShellRB, (you may have guessed it), simply run:
```
rake upgrade
```
## Contributing
Want to contribute to ShellRB? Great! You can find the contributing guidelines [here](CONTRIBUTING.md).
## Code of Conduct
We highly appreciate good behaviour and kind treatment of others. See our [Code of Conduct](CODE_OF_CONDUCT.md).