klp3-code

v3.0.3

Published

6 months ago

🚀 Advanced AI Assistant - Умный AI-помощник с красивым интерфейсом, встроенным Groq AI, системой плагинов

0High
0Medium
0Low

kilopa

ai assistant chatbot groq mixtral code-generation python cli terminal plugins dark-theme animations

🚀 Klp3 AI - Advanced AI Assistant

🤖 Умный AI-ассистент с встроенным бесплатным Groq AI

🌙 Красивый темно-фиолетовый интерфейс с анимациями

🔌 Расширяемая система плагинов

⚡ Быстрая установка • 📖 Использование • 🔌 Плагины • 🛠️ Разработка

✨ Что такое Klp3?

Klp3 — это продвинутый AI-ассистент для командной строки, который работает "из коробки" без необходимости настройки API ключей. Встроенный бесплатный Groq AI (Mixtral 8x7B) обеспечивает быстрые и качественные ответы.

🎯 Основные особенности

🆓 Бесплатный AI — встроенный Groq Mixtral, никаких API ключей не нужно
⚡ Сверхбыстрая работа — асинхронная архитектура и оптимизированные запросы
🌙 Красивый интерфейс — темно-фиолетовая тема с анимациями как у Claude Code
🎨 Генерация кода — Python, JavaScript, HTML, CSS и другие языки
🔌 Система плагинов — легко расширяется пользовательскими плагинами
📊 Умная статистика — отслеживание токенов и производительности
🔄 Автообновления — автоматическая проверка и установка обновлений
💾 Сохранение сессий — история разговоров сохраняется автоматически

⚡ Установка

Через NPM (Рекомендуется)

# Глобальная установка
npm install -g klp3-code

# Запуск
klp3

Требования

Python 3.8+ - Скачать Python
Node.js 14+ - Скачать Node.js

Klp3 автоматически установит необходимые Python зависимости при первом запуске.

📖 Использование

Запуск

klp3

При первом запуске Klp3:

🔍 Проверит наличие обновлений
📦 Установит Python зависимости (если нужно)
📁 Создаст системные папки в ~/.klp3/
🚀 Запустится с красивым экраном приветствия

Основные команды

| Команда | Описание | |---------|----------| | /help | Показать справку | | /stats | Статистика использования | | /plugins | Управление плагинами | | /clear | Очистить экран | | /reset | Очистить историю чата | | /update | Проверить обновления | | /exit | Выйти из приложения |

Примеры использования

💬 Обычное общение

💬 Вы: Расскажи о квантовых компьютерах
🤖 Klp3 AI: Квантовые компьютеры — это вычислительные устройства...

🎨 Генерация кода

💬 Вы: Создай Python функцию для сортировки списка
🤖 Klp3 AI: 
```python
def sort_list(data, reverse=False):
    """
    Сортировка списка
    
    Args:
        data: Список для сортировки
        reverse: Обратная сортировка (по умолчанию False)
    
    Returns:
        list: Отсортированный список
    """
    return sorted(data, reverse=reverse)

# Пример использования
numbers = [3, 1, 4, 1, 5, 9, 2, 6]
sorted_numbers = sort_list(numbers)
print(sorted_numbers)  # [1, 1, 2, 3, 4, 5, 6, 9]


#### 🔌 Использование плагинов

💬 Вы: /ls 🔌 FileManager: 📁 Содержимое текущей папки: 📁 documents 📁 downloads
📄 readme.txt (1.2 KB)

💬 Вы: /system 🔌 SystemInfo: 🖥️ Система: Windows 11 🏗️ Архитектура: AMD64 💻 Процессор: Intel Core i7 🐍 Python: 3.11.5


---

## 🔌 Плагины

Klp3 поставляется с встроенными плагинами и поддерживает пользовательские расширения.

### Встроенные плагины

#### 📁 FileManager
- `/ls [path]` - Список файлов и папок
- `/cat <file>` - Просмотр содержимого файла
- `/mkdir <dir>` - Создание папки
- `/pwd` - Текущая папка

#### 🖥️ SystemInfo  
- `/system` - Информация о системе
- `/memory` - Использование памяти
- `/disk` - Использование диска
- `/python` - Информация о Python

### Управление плагинами

```bash
# Список всех плагинов
/plugins list

# Включить плагин
/plugins enable FileManager

# Выключить плагин  
/plugins disable SystemInfo

# Перезагрузить плагины
/plugins reload

Создание собственных плагинов

Скопируйте шаблон:

cp ~/.klp3/templates/plugin_template.py ~/.klp3/plugins/my_plugin.py

Отредактируйте плагин:

class MyPlugin(BasePlugin):
    def get_name(self) -> str:
        return "MyPlugin"
       
    def can_handle(self, command: str) -> bool:
        return command.startswith("/my_command")
       
    async def handle_command(self, command: str, context=None):
        return {"success": True, "result": "Привет из плагина!"}
   
plugin = MyPlugin()

Перезагрузите плагины:
```
/plugins reload
/plugins enable MyPlugin
```

📁 Структура системных папок

Klp3 создает папки в домашней директории:

~/.klp3/                    # Главная папка
├── plugins/                # Пользовательские плагины
│   ├── plugin_template.py  # Шаблон для создания плагинов
│   └── my_plugin.py        # Ваши плагины
├── data/                   # Сессии и данные
├── cache/                  # Кэш системы
└── config.json            # Пользовательские настройки

🛠️ Разработка плагинов

Базовая структура плагина

from core.plugins import BasePlugin

class MyPlugin(BasePlugin):
    def get_name(self) -> str:
        return "MyPlugin"
    
    def get_description(self) -> str:
        return "Описание плагина"
    
    def get_version(self) -> str:
        return "1.0.0"
    
    def get_commands(self) -> List[str]:
        return ["/my_command - Описание команды"]
    
    async def initialize(self) -> bool:
        # Инициализация плагина
        return True
    
    async def cleanup(self):
        # Очистка ресурсов
        pass
    
    def can_handle(self, command: str) -> bool:
        return command.startswith("/my_command")
    
    async def handle_command(self, command: str, context=None):
        return {
            "success": True,
            "result": "Результат выполнения команды"
        }

# Обязательно: экспорт плагина
plugin = MyPlugin()

API для плагинов

Возвращаемые значения

Метод handle_command() должен возвращать словарь:

# Успешное выполнение
{
    "success": True,
    "result": "Текст для показа пользователю"
}

# Ошибка
{
    "success": False, 
    "error": "Описание ошибки"
}

Контекст выполнения

Параметр context может содержать:

user_input - исходный ввод пользователя
session - информация о сессии
Другие данные от системы

Советы по разработке

🔒 Безопасность - проверяйте входные данные, не используйте eval()
⚡ Производительность - делайте долгие операции асинхронными
🎨 UX - используйте понятные сообщения и эмодзи
🧪 Тестирование - проверяйте edge cases
📝 Документация - описывайте команды в get_commands()

⚙️ Конфигурация

Настройки пользователя

Файл ~/.klp3/config.json:

{
  "ui": {
    "animations": true,
    "typing_effect": true,
    "auto_save_sessions": true
  },
  "system": {
    "check_updates": true,
    "max_history": 50,
    "auto_load_plugins": true
  },
  "plugins": {
    "auto_install_examples": true,
    "safety_check": true,
    "max_plugins": 10
  }
}

Переменные окружения

Klp3 не требует настройки переменных окружения - все работает "из коробки".

🔄 Обновления

Klp3 автоматически проверяет обновления при запуске (не чаще раза в день).

Ручная проверка обновлений

# В приложении
/update

# Или через npm
npm update -g klp3-code

Что включают обновления

🐛 Исправления ошибок
✨ Новые функции
🔌 Улучшения системы плагинов
🎨 Улучшения интерфейса
⚡ Оптимизация производительности

📊 Статистика

Klp3 отслеживает использование и показывает статистику:

📊 Статистика использования
┌─────────────────────┬──────────────────┐
│ Метрика             │ Значение         │
├─────────────────────┼──────────────────┤
│ 🤖 AI Модель        │ mixtral-8x7b-32768│
│ 🆓 Провайдер        │ Groq (Free)      │
│ 📊 Токены (сессия)  │ 1,247            │
│ 📈 Токены (всего)   │ 5,892            │
│ 🔄 Запросов         │ 23               │
│ 💬 Сообщений        │ 46               │
│ ⏱️ Время сессии     │ 15м 32с          │
└─────────────────────┴──────────────────┘

❓ FAQ

Нужны ли API ключи?

Нет! Klp3 использует встроенный бесплатный Groq AI. Никакой регистрации или ключей не требуется.

Работает ли офлайн?

Klp3 требует интернет-соединения для запросов к AI, но система плагинов и интерфейс работают локально.

Безопасно ли это?

Да! Klp3 не отправляет личные данные. История разговоров хранится только локально в ~/.klp3/data/.

Можно ли использовать другие AI модели?

В текущей версии встроен только Groq AI для простоты использования. Поддержка других провайдеров планируется в будущих версиях.

Как удалить Klp3?

# Удалить приложение
npm uninstall -g klp3-code

# Удалить данные (опционально)
rm -rf ~/.klp3

🐛 Сообщение об ошибках

Нашли ошибку? Создайте issue на GitHub:

Опишите проблему
Укажите версию (klp3 --version)
Приложите логи из ~/.klp3/cache/

🔗 Создать issue

🤝 Вклад в проект

Мы приветствуем вклад в развитие Klp3!

Способы помочь

🐛 Сообщать об ошибках
💡 Предлагать новые функции
🔌 Создавать плагины
📖 Улучшать документацию
⭐ Ставить звездочки на GitHub

Для разработчиков

# Клонировать репозиторий
git clone https://github.com/kilopa-ai/klp3-code.git
cd klp3-code

# Установить зависимости
pip install -r requirements.txt

# Запустить в режиме разработки
python main.py

📄 Лицензия

MIT License. Смотрите LICENSE для подробностей.

🙏 Благодарности

Groq за бесплатный доступ к Mixtral AI
Rich за красивый терминальный интерфейс
Claude за вдохновение дизайна
Всем контрибьюторам и пользователям! ❤️

Создано с ❤️ командой KilopaAI

🌟 GitHub • 📦 NPM • 💬 Поддержка