intro

Welcome to the Penguin AI Assistant documentation. Penguin is a modular, extensible AI coding assistant that supports various language models through LiteLLM.

Features

• Interactive conversations with AI
• File manipulation and code generation
• Web searches for up-to-date information
• Automated task execution
• Project management
• Custom tool integration
• Diagnostic logging and error handling

Quick Start

1. Clone the repository
2. Set up a virtual environment
3. Install dependencies: pip install -r requirements.txt
4. Configure your API keys in .env
5. Run the assistant: python main.py

For more detailed instructions, see the Getting Started guide.

Table of Contents

• Getting Started
• Configuration
• Usage Guide
  • Basic Usage
  • Automode
  • Task Management
  • Project Management
• Advanced Topics
  • Custom Tools
  • Error Handling
  • Diagnostics
• API Reference
  • PenguinCore
  • ChatManager
  • ToolManager
  • APIClient

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the GNU Affero General Public License v3.0. See the LICENSE file for details.