Mini-Kode

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

🌟 Зачем нужен Mini-Kode?

Mini-Kode — это образовательный проект, созданный, чтобы помочь разработчикам понять современную архитектуру агентов для программирования. Мы достигли идеального баланса между чрезмерно сложными проектами с открытым исходным кодом и упрощёнными демонстрационными примерами, предлагая полную, но при этом управляемую реализацию (14 тысяч строк продакшн-кода) со следующими возможностями:

• 📚 Образовательный подход в первую очередь — Чистая архитектура на основе OpenAI SDK с продуманным дизайном типов и подробными комментариями
• 🛠️ Полная система инструментов — Единый интерфейс с комплексными инструментами для работы с файлами, поиска и выполнения команд
• 🔌 Интеграция MCP — Подключение к внешним MCP-серверам для расширения функциональности
• ⚙️ Поддержка нескольких LLM — Совместимость с OpenAI API, включая GLM, DeepSeek и другие популярные модели
• 🤖 Цикл агента — Полный рабочий процесс LLM с потоковой передачей ответов и подтверждением разрешений в цикле с участием человека
• 🎨 Современный интерфейс — Терминальный интерфейс на базе React/Ink с поддержкой тем

🚀 Быстрый старт (Установка и использование)

Глобальная установка

npm install -g mini-kode

Настройка API-ключа

DeepSeek (протестировано и проверено):

export DEEPSEEK_API_KEY="your-deepseek-api-key"

Или используйте GLM (智谱AI) (протестировано и проверено):

export GLM_API_KEY="your-glm-api-key"

Или используйте OpenAI-совместимый API:

export OPENAI_API_KEY="your-openai-api-key"
# or
MINIKODE_API_KEY="your-api-key"
MINIKODE_BASE_URL="https://your-api-provider.com/v1"
MINIKODE_MODEL="your-model-name"

Запуск Mini-Kode

# Interactive mode (launch UI)
mini-kode

# Non-interactive mode (direct execution)
mini-kode "help me fix the bug in auth.ts"

🔧 Быстрый старт для разработчиков

Предварительные требования

• Bun
• pnpm

Установка зависимостей

pnpm install

Команды для разработки

# Development mode with file watching
pnpm run dev

# Build
pnpm run build

# Test
pnpm run test

📖 Обучающие материалы

Хотите глубже разобраться в архитектуре системы? Обратитесь к docs/README.md за полной документацией по системе и объяснением архитектуры.

📚 Анализ проекта

Для всестороннего анализа кода и подробного разбора посетите Глубокий анализ Mini-Kode — подробное исследование архитектуры кодовой базы, паттернов проектирования и деталей реализации.

🧠 Память проекта

Mini-Kode автоматически использует файл AGENTS.md в корне вашего проекта для контекстно-зависимой помощи:

• Автоматический контекст: Система читает AGENTS.md, чтобы понять ваш проект
• Настраиваемость: Отредактируйте AGENTS.md, чтобы добавить информацию, специфичную для проекта
• Постоянная память: Сохраняет контекст проекта между сессиями

🏗️ Структура проекта

src/
├── tools/          # Tool system and individual tools
├── ui/             # Ink-based CLI interface components
├── llm/            # LLM client and streaming integration
├── permissions/    # Two-layer permission system
├── config/         # Configuration management
├── cli/            # CLI framework and commands
├── agent/          # Core agent logic
├── sessions/       # Session management
└── utils/          # Shared utilities

🛠️ Технологический стек

• TypeScript — Статическая проверка типов
• pnpm — Управление пакетами
• Ink — Терминальный интерфейс на React
• OpenAI SDK — Интеграция LLM (поддерживает DeepSeek/OpenAI/совместимые API)
• Vitest — Фреймворк для тестирования
• Zod — Проверка типов во время выполнения
• Commander — Фреймворк для CLI

🚧 Планы на будущее

1. Сохранение и возобновление сессий — Сохранение и восстановление сессий агента
2. Интеграция встроенных инструментов LLM — Поддержка нативных инструментов LLM (примечание: DeepSeek в настоящее время не поддерживает инструменты веб-поиска)
3. Поддержка ввода изображений — Обработка и анализ изображений
4. Функциональность субагентов — Иерархическое делегирование задач агентам
5. Поддержка моделей рассуждений — Интеграция с моделями, специализирующимися на рассуждениях
6. Потоковая передача сообщений о вызовах инструментов — Потоковая передача выполнения инструментов в реальном времени
7. Кэширование контекста — Умное кэширование контекста разговора для снижения расхода токенов

📚 Ссылки

Этот проект был вдохновлён следующими ресурсами и ссылается на них:

• Создание агента — Руководство по созданию AI-агентов
• Создание агентной системы — Подробное руководство по созданию агентных систем
• Системные промпты и промпты для инструментов — Системные промпты и промпты для инструментов агента программирования
• Neovate Code — Промпт для инструмента Todo
• Claude Code — Справочник по UX для дизайна CLI-интерфейса