Getting Started with Rusty Buddy CLI

Welcome to Rusty Buddy CLI! This guide will walk you through the installation process, setup, and basic usage to get you up and running efficiently.

Installation

Rusty Buddy CLI can be installed quickly using a script, or manually by cloning the repository and building it. Choose the method that suits your requirements.

Quick Installation Using Script

For a quick setup on Unix-based systems (Linux/macOS), run the following command in your terminal:

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

Manual Installation

Clone and Build

1. Clone this repository:

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

1. Change to the project directory:

   cd rusty-buddy

1. Build the project:

   cargo build --release

1. Set up an environment file for OpenAI API key:

   OPENAI_KEY=your_openai_api_key

Platform-Specific Installation

Refer to our Download Page for platform-specific installation guides for Windows, macOS, and Linux.

Initial Setup

Run the Init Command

To configure Rusty Buddy CLI with necessary credentials and settings, use the init command:

rusty-buddy init

Configuration File

A config.toml file is created in the .rusty directory. You can customize it to tailor personas and settings as per your requirements.

Basic Usage

Once installed, you can start using Rusty Buddy CLI to enhance your development process.

Common Commands

• Generate Background Images:

  rusty-buddy create-background --orientation landscape --output ./backgrounds

• Generate Commit Messages:

  git add .
  rusty-buddy commit-message

• Start a Chat Session:

  rusty-buddy chat --new

• Fulfill Development Wishes:

  rusty-buddy wish ./src --tools

Explore More

• Documentation: Delve into comprehensive documentation for more features and advanced usage.
• Subscribe: Stay updated on our latest features and improvements by subscribing to our github project.

Happy coding! With Rusty Buddy CLI, streamline your tasks and focus on what truly matters.