Rusty Buddy

Empower Your Development Workflow with AI

Rusty Buddy is an AI-powered command-line tool designed to supercharge your development workflow. Whether you're seeking to generate code automatically, refine commit messages, or engage in insightful AI-assisted chats, Rusty Buddy brings state-of-the-art machine learning directly to your terminal.

---

🚀 What's New in Version 1.1.0

Knowledge Management System 💡

• Structured Knowledge Integration: Introducing a comprehensive knowledge management system that lets you effortlessly add, search, and use knowledge entries. This enhances Rusty Buddy's ability to interact with your project context, offering tailored suggestions and insights.
• Enhanced Contextual Assistance: Utilize the --knowledge flag in chats to access a knowledge database, enriching AI's responses with precise, context-aware information for your tasks.

New CLI Commands and Enhancements 🤖

• Copy Commands: Streamline your coding process with /copy-last-message and /copy-files, making it easier to access past messages or code snippets directly.
• Extended Command Flexibility: Now supporting multiple directory specifications and a direct message input option to improve command usability.

Improved Documentation 📚

• A modern update with mkdocs-material, enhancing command readability and including additional examples to help you use the new knowledge features effectively.

Explore these features and improve your development workflow with Rusty Buddy v1.1.0, bringing a smarter, more intuitive assistance to your projects.

---

Why Choose Rusty Buddy?

• Streamline Workflows
  Automate mundane tasks and focus on building amazing software.

• AI-Powered Assistance
  Leverage advanced AI models for code generation, debugging, documentation, and more.

• Context-Aware Interaction
  Rusty Buddy adapts to your project's context, providing relevant suggestions and insights.

• Customizable Personas
  Tailor AI interactions with a variety of personas specialized in different domains.

---

Key Features

• Intuitive Chat Interface
  Engage in natural language conversations with the AI assistant to brainstorm ideas, solve problems, or get code assistance.

• Slash Command Auto-Completion
  Boost your efficiency with intelligent command suggestions and auto-completion within the chat interface.

• Commit Message Generator
  Generate clear and consistent commit messages automatically from your git diffs, following best practices.

• Icon and Background Image Generation
  Create stunning visuals effortlessly with AI-generated graphics based on your descriptions.

• Tool Integration
  Automate repetitive tasks by allowing the AI to interact with your files and directories, enhancing your development process.

• Shell Completion Support
  Improve your command-line experience with shell completion scripts for Bash, Zsh, Fish, and more.

---

Security and Privacy

• Developed in Rust
  Benefit from Rust's memory safety guarantees, ensuring a secure and reliable toolset.

• Privacy First
  Rusty Buddy operates entirely within your local environment¹, with no data collection, giving you complete control and peace of mind.

---

Installation

You can set up Rusty Buddy using either the quick script method or by building it from source.

Method 1: Install Using Script

For a hassle-free setup, execute the following script:

curl -sSL https://get.rusty-buddy.org | bash

Note: Ensure you have the necessary permissions to run installation scripts on your system.

Method 2: Clone and Build

1. Clone the Repository

   git clone https://github.com/hg8496/rusty-buddy.git

2. Navigate to the Project Directory

   cd rusty-buddy

3. Build the Project

   cargo build --release

---

Getting Started

After installation, perform initial configurations using the init command:

rusty-buddy init

The setup process will:

1. Choose Your AI Backend

   • OpenAI: Enter your OpenAI API key.

   • Ollama: Enter the Ollama API URL and model name.

     Choose backend to use (1 for OpenAI, 2 for Ollama): [User enters 1 or 2]
     

2. Persona Recommendation

   • Rusty Buddy analyzes your project directory and recommends a suitable persona.

     Analyzing project directory...
     Recommended persona: [Persona]
     

3. Create Configuration Files

   • Generates .env and config.toml files in the .rusty directory.

---

Example Usage

• Start a New Chat Session

  rusty-buddy chat --new

• Generate a Commit Message

  git add .
  rusty-buddy commit-message

• Create an Icon

  rusty-buddy create-icon --output ./icons --sizes 64,128,256

• Use a Specific Persona

  rusty-buddy chat --persona rust

• Fulfill a Wish

  rusty-buddy wish ./src --tools

---

Documentation

• Installation Guide
• Getting Started
• Commands Overview
• Working with Personas
• Use Cases

---

Join Our Community

• GitHub Repository
• Official Documentation
• Contact Support

---

Happy Coding with Rusty Buddy!

---

---

License

Rusty Buddy is released under the MIT License. See the LICENSE file for more details.

---

Contact

For further queries or support, feel free to reach out at [email protected].

---

Embrace the future of development with Rusty Buddy—your AI-powered assistant!

Footnotes

1. If you are using a local Ollama installation for AI workloads. ↩