Skip to content

Commit 1a5f3f4

Browse files
authored
Merge pull request #217 from ProverCoderAI/docs/update-readme-bun-workflow
docs(readme): document bun workflow
2 parents 1909b2f + 098d119 commit 1a5f3f4

1 file changed

Lines changed: 71 additions & 4 deletions

File tree

README.md

Lines changed: 71 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,29 @@
55

66
## Что нужно
77

8+
- Bun `1.3+`
89
- Docker Engine или Docker Desktop
910
- Доступ к Docker без `sudo`
10-
- Node.js и `npm`
11+
- Git и OpenSSH client (`ssh`, `ssh-keygen`)
12+
- GitHub CLI `gh` для `docker-git auth github login --web`
13+
14+
`Node.js` не является основным runtime для `docker-git`: CLI и workspace запускаются через Bun.
15+
Node всё ещё устанавливается внутри создаваемых Docker-сред, потому что часть агентских CLI зависит от Node ecosystem.
1116

1217
## Установка
1318

1419
```bash
15-
npm i -g @prover-coder-ai/docker-git
20+
bun add -g @prover-coder-ai/docker-git
1621
docker-git --help
1722
```
1823

24+
Локальный запуск из репозитория:
25+
26+
```bash
27+
bun install
28+
bun run docker-git --help
29+
```
30+
1931
## Авторизация
2032

2133
```bash
@@ -24,7 +36,7 @@ docker-git auth codex login --web
2436
docker-git auth claude login --web
2537
```
2638

27-
## Пример
39+
## CLI пример
2840

2941
Можно передавать ссылку на репозиторий, ветку (`/tree/...`), issue или PR.
3042

@@ -45,6 +57,61 @@ docker-git clone https://github.com/ProverCoderAI/docker-git/issues/122 --force
4557
- `--auto=claude` или `--auto=codex` принудительно выбирает агента.
4658
- В auto-режиме агент сам выполняет задачу, создаёт PR и после завершения контейнер очищается.
4759

60+
## Browser frontend
61+
62+
Browser UI использует тот же backend-контракт, что и CLI. API находится в `packages/api`,
63+
а frontend shell в `packages/app`.
64+
65+
Dev-режим:
66+
67+
```bash
68+
bun install
69+
bun run api:start
70+
```
71+
72+
Во втором терминале:
73+
74+
```bash
75+
bun run web:dev
76+
```
77+
78+
Открой `http://127.0.0.1:4174/`.
79+
80+
Preview собранного frontend:
81+
82+
```bash
83+
bun run web:build
84+
bun run web:serve
85+
```
86+
87+
Открой `http://127.0.0.1:4191/`.
88+
`web:serve` проксирует `/api` и WebSocket terminal-сессии в API на `127.0.0.1:3334`.
89+
90+
## Архитектура workspace
91+
92+
- `packages/app` — CLI/Web frontend, renderer, API client.
93+
- `packages/api` — HTTP/WebSocket controller, единственный backend entrypoint для frontend.
94+
- `packages/lib` — бизнес-логика, Docker/SSH/usecase слой.
95+
96+
Frontend не должен напрямую вызывать бизнес-логику из `packages/lib`; он работает через `packages/api`.
97+
98+
## Проверки
99+
100+
```bash
101+
bun run typecheck
102+
bun run lint
103+
bun run lint:effect
104+
bun run test
105+
```
106+
107+
E2E:
108+
109+
```bash
110+
bun run e2e
111+
```
112+
48113
## Подробности
49114

50-
`docker-git --help`
115+
```bash
116+
docker-git --help
117+
```

0 commit comments

Comments
 (0)