🚀 Buddy CLI

Welcome to Buddy CLI - your friendly command line companion powered by generative AI! 🌟

Buddy is a powerful tool that helps you execute shell-related tasks, learn new concepts, and automate your workflows with ease. Whether you're a seasoned developer or just getting started, Buddy is here to make your life easier.

🌟 Features

Task Automation 🤖

Sometimes you have some pretty straightforward tasks that are hard to mess up, and it can be a pain memorizing the plethora of shell commands that are available - especially if you've got to chain them together. Buddy can automatically handle just about any task in your terminal by itself, if you're cool with that sort of thing, anyway.

Safety Guards ⚠️

If you're sane, you probably don't want these models having direct access to your system to where they can modify just about anything and potentially cause some real damage. In these cases, if you're fearful, you can ask Buddy to carefully complete a task which allows you to approve every command that is potentially dangerous (so anything that isn't reading something.)

Guided Walkthroughs 🎓

Some of us just aren't that great with command-line, and that's okay. It can be a lot to learn and keep track of, especially if you're working in different flavors of Linux or even different operating systems semi often. Luckily, Buddy has your back! 👏

By asking Buddy for help with a task, it will create a plan and walk you through executing it step-by-step. As it moves through the process with you, you are able to suggest changes and approve everything it does. As you move through each step, Buddy will provide educational context as to why each step is happening and, in the case of issues, it will help you find workaround and explain what it all means.

Explanations💡

We've all read through guides and followed tutorials online where the author gives you commands to run in your shell but without the context explaining what exactly it does, or why it does it. Buddy can give you in-depth explanations of commands or command chains before you run them yourself so you can be sure you know what it's about to do - or at least learn about why it works the way it does.

Extending Capabilities 📈

It doesn't end there. Buddy also comes with separate modules that can be enabled: models and abilities.

Model Support

The following LLMs are supported through Buddy:

• OpenAI: GPT-4, GPT-4o, GPT-4o Mini, GPT-3.5 Turbo
• Google: Gemini 1.5 Pro, Gemini 1.5 Flash
• Anthropic: Claude 3.5 Sonnet, Claude 3 Haiku

Abilities

Want to go even further than your own shell's capabilities? Well, Buddy is quite capable of performing more specialized tasks through a modular ability system. Abilities expand Buddy's toolset by enabling special prompt flows, including ones that use external tools to get the work done.

• 🌍 Browsing: Enable Buddy to utilize Chrome to search the web and interact with webpages for research tasks.
• 🚧🔬 Analysis: Give Buddy the ability to read and understand spreadsheets, PDFs, and images.
• 🚧👀 Watching: Let Buddy watch a stream of logs for you and only tell you about what you want to know.
• 🚧🧑‍💻 Web Development: Buddy can help you reason about your React or Angular app
• 🚧📃 Documentation: Ask Buddy to write that README for you (...like this one)
• 🚧🗃️ Database Administration: Allow Buddy to help you query and mutate data in MySQL, Postgres, or SQL Server
• 🚧☁️ Cloud: Build out your provisioning templates and manage your resources effectively

🚀 Getting Started

Prerequisites

• Python 3.8+
• Docker (for isolated testing)

Installation

1. Clone the repository:

   git clone https://github.com/cameron5906/buddy-cli.git
   cd buddy-cli

2. Set up a virtual environment:

   python3 -m venv venv
   source venv/bin/activate  # On Windows use `venv\Scripts\activate`

3. Install the dependencies:

   pip install -r requirements.txt

Running Buddy CLI

To run Buddy CLI, simply use the following command:

python ./src/buddy_cli.py <input> [options]

For example:

python ./src/buddy_cli.py help set up a minecraft server using Docker

Using Docker for Testing

If you want to play around with Buddy CLI without fear of something going wrong (for it to gain your trust) you can run it in an isolated container environment based.

Operating Systems

The following base images can be used to test with:

• Ubuntu
• Debian
• CentOS
• Alpine

Running the Sandbox

You can run the start_sandbox.py script in the sandbox directory to get an environment up and running.

There are several options you can use along with it:

Defaults:
    os: ubuntu
    root: False

Options:
    --update: Update the existing sandbox environment with the latest files, don't rebuild the environment
    --open: Attach to the existing sandbox container without rebuilding the environment
    --os: Specify the operating system environment to use
    --root: Use the root variant of the environment

You can use python start_sandbox.py --help for the full output.

📚 Commands

• buddy info - Display usage instructions and current configuration for Buddy CLI
• buddy install [name] - Allows you to install Buddy as a shell alias so you can run it anywhere without a Python prefix or path. You can even name it whatever you want.
• buddy <task> - Let Buddy handle a task without any supervision (WARNING: be careful!)
• buddy carefully <task> - Let Buddy handle a task, but with user confirmation for every non-read action
• buddy explain <task> - Get detailed and informative documentation on any command(s) before you run them through your shell
• buddy help <task> - Let Buddy develop a plan for a task and walk you through it step-by-step, providing educational context along the way. If issues are encountered, Buddy will help you through it and make sure you know what's going on. It will even help you test & validate changes afterwards.
• buddy use <provider/ability> <name> [options] - Enable Buddy to use a specific model or extra ability when working on tasks
• buddy remove <provider/ability> - Removes Buddy's ability to use an ability, also removing its configuration

🛠 Development

Feel free to contribute to Buddy CLI! Here's how you can get started:

1. Clone the repository:

   git clone https://github.com/cameron5906/buddy-cli.git

2. Create a new branch:

   git checkout -b my-feature

3. Make your changes and commit them early and often:

   git commit -m "All about my cool feature"
   ...

4. Push to the branch:

   git push origin my-feature-branch

5. Create a new Pull Request.

📄 License

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

🙏 Acknowledgements

• Thanks to OpenAI, Google, and Anthropic, and the Open Source community for developing this technology
• Inspired by the needs of developers and those learning their way around the command-line, everywhere.