Skip to main content

Penguin AI Assistant Documentation

Welcome to the Penguin AI Assistant documentation. Penguin is a modular, extensible AI coding agent that supports various language models through LiteLLM, now with enhanced project management and web interface capabilities.

Features​

  • File manipulation and code generation
  • Web searches for up-to-date information
  • Automated task execution with Run Mode
  • Project management
  • Custom tool integration
  • PyDoll browser automation
  • Memory search across conversations
  • Pluggable memory providers with vector search
  • Diagnostic logging and error handling

Quick Start​

Installation Options​

Default Installation (includes CLI tools):

pip install penguin-ai

With Web Interface:

pip install penguin-ai[web]

Minimal Installation (library only):

pip install penguin-ai[minimal]

Basic Usage​

Command Line Interface:

# Interactive chat
penguin

# Direct commands
penguin "Write a hello world script"

# Project management
penguin project create "My Project"
penguin task create "Implement authentication"

Web Interface:

# Start web server (requires [web] extra)
penguin-web

Python API:

from penguin import PenguinAgent

agent = PenguinAgent()
response = agent.chat("Help me debug this function")

Documentation Structure​

Getting Started​

Usage Guides​

Advanced Topics​

API Reference​

Architecture Overview​

Penguin v0.2.0 introduces a clean modular architecture:

  • penguin.cli - Command-line interface and tools
  • penguin.web - Web interface and REST API (optional)
  • penguin.project - SQLite-backed project and task management
  • penguin.core - Core engine and coordination layer
  • penguin.memory - Conversation and knowledge persistence
  • penguin.tools - Extensible tool ecosystem

Contributing​

Contributions are welcome! Please see our contributing guidelines for details.

License​

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