Skip to content

Commit 20be607

Browse files
authored
Update README.md
1 parent 439219a commit 20be607

File tree

1 file changed

+45
-38
lines changed

1 file changed

+45
-38
lines changed

README.md

Lines changed: 45 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,86 @@
11
# ADV Keeper (CLI/TUI)
22

3-
Лёгкий офлайн-клиент для загрузки и скачивания файлов через gRPC с удобным TUI-интерфейсом на Bubble Tea.
3+
Лёгкий клиент/сервер для загрузки и скачивания файлов по gRPC с TUI-интерфейсом на Bubble Tea.
44
**Ничего ставить не нужно, кроме `make` и вашей ОС.**
55

6+
> **Просьба:** для корректного отображения интерфейса **всегда разворачивайте терминал на полный экран** (fullscreen).
7+
>
8+
> **Мышь:** пока **не поддерживается** — работаю над этим. Используйте клавиатуру (см. ниже).
9+
10+
---
11+
612
## Быстрый старт
713

8-
```bash
9-
# 1) Запуск сервера
10-
make server # или make run-server / make run — смотрите цели в Makefile
11-
```
1214
# 2) В другом терминале — запуск TUI-клиента
13-
make tui # или make run-tui / make client — по Makefile
14-
Если в вашем Makefile другие имена целей — используйте их. Смысл простой: одна цель стартует сервер, другая — клиент.
15-
16-
Учётная запись (демо)
15+
make tui # (или make run-tui — см. Makefile)
1716
Войти можно тестовым аккаунтом:
1817

1918
makefile
2019
Copy code
21-
Логин: admin
22-
Пароль: admin
20+
Логин: admin
21+
Пароль: admin
2322
Как пользоваться
2423
Загрузка файла (Upload)
25-
В главном меню выберите Upload (стрелки ↑/↓, Enter).
26-
27-
Выберите файл через встроенный файловый диалог.
28-
29-
Во время загрузки увидите:
24+
В главном меню выберите Upload (↑/↓ и Enter).
3025

31-
прогресс-бар, проценты,
26+
Укажите файл во встроенном файловом диалоге.
3227

33-
скорость передачи и ETA,
28+
Во время загрузки видно прогресс-бар, скорость и ETA; ESC — отмена.
3429

35-
подсказку ESC — отмена.
36-
37-
По завершении вернёт в список файлов (FileList).
30+
После завершения вы вернётесь к списку файлов (FileList).
3831

3932
Скачивание файла (Download)
4033
Откройте FileList.
4134

42-
Стрелками выберите нужный файл, Enter → Download.
35+
Выберите файл, Enter → Download.
4336

44-
Прогресс отображается так же, как при upload.
37+
Прогресс отображается так же, как при загрузке.
4538

46-
Готовый файл сохраняется рядом с приложением (в текущей папке, где запущен клиент/бинарь).
39+
Файл сохраняется рядом с приложением (в текущей директории запуска клиента).
4740

48-
Если не уверены, где окажется файл — посмотрите текущую директорию (pwd на macOS/Linux или cd без аргументов в Windows).
41+
Где окажется файл: это текущая папка процесса (pwd на macOS/Linux или просто cd в Windows).
4942

50-
Клавиши
51-
↑ / ↓ / j / k — навигация по меню/таблицам
43+
Управление (клавиатура)
44+
↑ / ↓ / j / k — навигация
5245

53-
Enter — выбрать
46+
Enter — выбрать/подтвердить
5447

5548
ESC — назад/отмена/снять фокус
5649

5750
Ctrl+C — выход
5851

59-
Во время загрузки/скачивания:
52+
Во время upload/download: ESC — отменить операцию
6053

61-
ESC — отменить операцию
54+
Мышь временно не работает — поддержка в разработке.
6255

63-
Что внутри (коротко)
64-
gRPC сервер и TUI-клиент.
56+
Сборка под платформы
57+
Цели Makefile для сборки бинарей:
6558

66-
Передача файлов чанками, с расчётом прогресса/скорости/ETA.
59+
make
60+
Copy code
61+
linux-amd64: build-linux_amd64
62+
linux-arm64: build-linux_arm64
63+
windows-amd64: build-windows_amd64
64+
darwin-arm64: build-darwin_arm64
65+
Примеры:
6766

68-
Сессия сохраняется и очищается при Logout.
67+
bash
68+
Copy code
69+
make linux-amd64 # Linux x86_64
70+
make linux-arm64 # Linux ARM64
71+
make windows-amd64 # Windows x86_64
72+
make darwin-arm64 # macOS Apple Silicon
73+
(Имена файлов артефактов и папка вывода смотрите в Makefile.)
6974

7075
Демо-видео
71-
В качестве примера можно взять видео с Дуэйном Джонсоном (The Rock):
76+
В качестве тестового файла можно взять видео с Дуэйном Джонсоном (The Rock):
7277
https://www.youtube.com/watch?v=skeQ9C7JuG4
7378

7479
Траблшутинг
75-
“Висит загрузка” — убедитесь, что сервер запущен до старта клиента.
80+
“Загрузка/скачивание висит” — убедитесь, что сервер запущен до клиента.
81+
82+
“Не логинится” — проверьте демо-учётку admin/admin.
7683

77-
“Не логинится” — проверьте демо-логин/пароль admin/admin.
84+
“Не вижу скачанный файл” — проверьте текущую директорию клиента; файл сохраняется рядом с бинарём.
7885

79-
Не вижу скачанного файла” — проверьте текущую директорию клиента; файл сохраняется рядом с бинарём.
86+
TUI едет/обрезается” — разверните терминал на полный экран.

0 commit comments

Comments
 (0)