BashBuddy

BashBuddy is a specialized CLI tool designed to organize your shell commands into easily manageable projects and aliases. It enhances productivity by streamlining your workflow through quick access to frequently used commands, organized into well-defined categories.

Installation

Development

First, clone the repository:

git clone git@github.com:matissecallewaert/bashbuddy.git

Then, navigate to the project directory and run the following command to install the package:

cargo build

Finally, you can test the installation by running the following command:

cargo run -- help

Usage

Using the TUI (Terminal User Interface)

To launch the TUI, run the following command:

bsh

Using the CLI (Command Line Interface)

Execute commands using:

bsh [CATEGORY] [COMMAND]

Available Commands

• add or a: Adds a new command to a category or creates a new category if no command is given.
• run or r: Executes a command from a specified category.
• delete or d: Removes a command from a category or deletes the category entirely if no command is specified.

Global Options

• -h, --help: Displays help information.
• -V, --version: Displays the version information.

Detailed Command Usage

Adding Commands or Categories

bsh add <CATEGORY> [ALIAS] [COMMAND]

• <CATEGORY>: Specifies the category to which the command will be added, or a new category to be created.
• [ALIAS]: Optional. Specifies an alias for the command.
• [COMMAND]: Optional. Specifies the command to be added. If only the category is provided, a new category will be created without adding any commands.

Example:

bsh a utilities ping 'ping example.com'

This adds a new command 'ping example.com' with alias 'ping' to the 'utilities' category.

Running Commands

bsh r <CATEGORY> <ALIAS>

• <CATEGORY>: The category from which the command will be run.
• <ALIAS>: The alias of the command to be executed.

Example:

bsh run utilities ping

This executes the 'ping' command in the 'utilities' category.

Deleting Commands or Categories

bsh delete <CATEGORY> [ALIAS]

• <CATEGORY>: Specifies the category from which the command will be removed, or the category to be deleted if no alias is provided.
• [ALIAS]: Optional. Specifies the alias of the command to remove. If no alias is provided, the entire category will be deleted.

Example:

bsh delete utilities ping

This removes the 'ping' command from the 'utilities' category.

---

Additional Information

• For a complete list of commands and their options, you can always run bsh help or bsh help [COMMAND] for details about a specific command.

License

This project is licensed under the MIT License - see the LICENSE file for details.