opencode-config/README.md
Sergey 4e926a43a7
fix(readme): russian heading, simplified support, access_url, env username (#118)
* fix(readme): russian heading, simplified support, access_url, env username

* fix(ci): wrap long assert to satisfy ruff E501 in test_permissions.py

* docs(project-map): add PR#118 tags (create-readme, repo-readme, .env.example)

* fix(ci): format test_permissions.py for ruff format check

---------

Co-authored-by: opencode-agent <agent@opencode.local>
2026-07-29 04:56:35 +03:00

92 lines
No EOL
4.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 🚀 opencode-config
> Portable AI coding assistant config with memory & subagent pipeline
[English](#-english) | [Русский](#-русский)
---
## 🇬🇧 English
<!-- summary-en:start -->
### ❓ Why
Moving your AI coding assistant config to a new server meant setting everything up from scratch every time. Plus no versioning — break a skill and you can't rollback to what worked.
### ✅ What
A ready-to-run Docker config. Clone, fill `.env`, start — it works. Versioning via Git, memory syncs through a private repository.
<!-- summary-en:end -->
<!-- features-en:start -->
### Features
| Feature | Description |
|---------|-------------|
| 🐳 Portable | Docker config — runs on any server with one command |
| 📦 Versioning | Git under the hood — rollback to any config version |
| 🌐 Global skills | All skills mounted via volume — work across all projects |
| 🧠 Portable memory | Markdown + git, syncs through private repo — assistant remembers everything |
| 🔍 Dual search | Keyword (ripgrep) always works, semantic — optional via OpenAI API |
| 🔧 Pipeline | ISSUE → IMPLEMENT → DOCS → CI → REVIEW → MERGE → MEMORY |
| 🤖 Subagent orchestration | Orchestrator only plans, subagents execute |
| 📋 Linear execution | One pipeline at a time — no branch conflicts |
| 🐛 Auto-issue | Bug found mid-task — agent creates GitHub issue and continues |
| 🛠️ Skills & commands | Built-in skills and slash commands, main one — `/run-pipeline` |
| 👥 Subagents | Built-in role-based agents — review, docs, memory sync |
<!-- features-en:end -->
### ⚡ Quick Start
```bash
git clone https://github.com/slaid098/opencode-config.git
cd opencode-config
cp .env.example .env
docker compose up -d
```
Access at http://localhost:4096
---
## 🇷🇺 Русский
<!-- summary-ru:start -->
### ❓ Зачем
Перенос конфига на новый сервер требовал настройки с нуля каждый раз. Плюс отсутствие версионирования — накосячил со скиллом и не можешь посмотреть, как было раньше.
### ✅ Что
Готовый конфиг в Docker. Клонировал, заполнил `.env`, запустил — работает. Версионирование через Git, память синкается через приватный репозиторий.
<!-- summary-ru:end -->
<!-- features-ru:start -->
### Фичи
| Фича | Описание |
|------|----------|
| 🐳 Переносимость | Docker-конфиг — поднимается на любом сервере одной командой |
| 📦 Версионирование | Git под капотом — откат к любой версии конфига |
| 🌐 Глобальные скиллы | Все скиллы прокидываются через volume — работают во всех проектах |
| 🧠 Переносимая память | Markdown + git, синк через приватный репозиторий — ассистент помнит всё |
| 🔍 Двойной поиск | Keyword (ripgrep) всегда работает, semantic — опционально через OpenAI API |
| 🔧 Пайплайн | ISSUE → IMPLEMENT → DOCS → CI → REVIEW → MERGE → MEMORY |
| 🤖 Subagent-оркестрация | Оркестратор только планирует, исполняют subagent'ы |
| 📋 Линейное выполнение | Один пайплайн за раз — без конфликтов веток |
| 🐛 Auto-issue | Баг найден в процессе — агент сам создаёт GitHub issue и продолжает работу |
| 🛠️ Скиллы и команды | Встроенные скиллы и slash-команды, основной — `/run-pipeline` |
| 👥 Subagent'ы | Встроенные агенты по ролям — review, docs, memory sync |
<!-- features-ru:end -->
### ⚡ Быстрый старт
```bash
git clone https://github.com/slaid098/opencode-config.git
cd opencode-config
cp .env.example .env
docker compose up -d
```
Доступ: http://localhost:4096
---
## 💬 Support and contacts / Поддержка и контакты
👉 **[slaid098.dev/support](https://slaid098.dev/support)**
## License
MIT — see [LICENSE](LICENSE).