https://github.com/a-k-o-r-a/boop-rs

A clone of the Boop App for Mac OS, written in Rust with egui.
https://github.com/a-k-o-r-a/boop-rs

clap cli rust terminal utility

Last synced: 26 days ago
JSON representation

A clone of the Boop App for Mac OS, written in Rust with egui.

• Host: GitHub
• URL: https://github.com/a-k-o-r-a/boop-rs
• Owner: A-K-O-R-A
• Created: 2023-01-04T15:11:02.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-21T22:16:38.000Z (10 months ago)
• Last Synced: 2024-01-21T23:20:02.245Z (10 months ago)
• Topics: clap, cli, rust, terminal, utility
• Language: Rust
• Homepage:
• Size: 155 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Boop

This project is heavily inspired by the [Boop App](https://boop.okat.best/) for macOS by [Ivan Mathy](https://github.com/IvanMathy). But why should macOS users be the only ones to enjoy this wonderful piece of software? To make this wonderful app available to everyone I created a clone of the Boop App in Rust.

## Usage

Right now this project is focused mainly on the CLI part which allows you to quickly convert strings in the terminal like this:

```bash

$ curl -s https://dummy.restapiexample.com/api/v1/employee/1 | boop run json.format

{

  "status": "success",

  "data": {

    "id": 1,

    "employee_name": "Tiger Nixon",

    "employee_salary": 320800,

    "employee_age": 61,

    "profile_image": ""

  },

  "message": "Successfully! Record has been fetched."

}

```

Instead of piping the input to boop directly you can also use it like this

```bash

$ boop run base64.decode "SGVsbG8gV29ybGQh"

Hello World!

```

If you want to load your own plugins you can do so by providing the `plugins-folder` option like `-p, --plugins-folder ` which will automatically recursively load all all plugins in that folder.

```bash

$ boop run -p "./plugins" general.remove_newlines $'\nHello,\n World!'

Hello World!

```

## Installation

Right now this project is not published anywhere so you'll need to clone this repository and build it yourself for now. The first official release date is not yet set.

If you just want to try out the project you can do so using the `cargo install` command.

```bash

cargo install --git https://github.com/A-K-O-R-A/boop-rs/ boop

```

The programm is shipped with some default plugins embedded into the executable and a loader for js plugins.

## Plugins & Loaders

### Default plugins

The `core` library exports some default plugins, by default these plugins are directly embedded into the application and are always available. These default plugins have the advantage of being blazingly fast so you can use them on huge files without problems.  

base64

 * base64.decode

 * base64.encode

html

 * html.decode

 * html.encode

json

 * json.stringify

 * json.parse

 * json.format

 * json.minify

jwt

 * jwt.decode

 * jwt.format

md5

 * md5.hash

text

 * text.lowercase

 * text.uppercase

 * text.reverse

 * text.remove_newlines

 * text.count_chars

 * text.count_lines

url

 * url.decode

 * url.encode

If you for some reason want to override these plugins you can turn of the individual features when compiling.

### Javascript

Of course external plugins are also supported. Right now there is only a loader for Javascript plugins implemented via the [`quick-js`](https://github.com/theduke/quickjs-rs) crate. You can easily write your own javascript plugins by just copying one of the examples in the `plugins` folder and changing the two functions.

The plugins need to have two functions `metadata(): Metadata` and `run(state: string): string`. When the plugins get loaded the `metadata()` function is executed once and its results get stored in memory. The `run` function get executed every time the plugin will be run with a single argument of the type `string`. Errors can be thrown by using the `throw` keyword (for example `throw "Invalid RGB notation"`).

### Other loaders

In the future it is planned to implement more loaders for languages like `lua`, but currently it is not the main focus of this project to implement a lot of diffrent loaders.

## GUI 

![Screenshot](./gui.png)

(Currently this the state of the GUI which, admittedly does not even look close to the orginal)

The original Boop App has a GUI instead of CLI so originally I wanted to recreate that, unfortunatly writing a GUI application in rust without any prior knowledge turned out to be harder than I thought. So for now this project is manly focused on the CLI part.