|
1 | 1 | # ADV Keeper (CLI/TUI) |
2 | 2 |
|
3 | | -Лёгкий офлайн-клиент для загрузки и скачивания файлов через gRPC с удобным TUI-интерфейсом на Bubble Tea. |
| 3 | +Лёгкий клиент/сервер для загрузки и скачивания файлов по gRPC с TUI-интерфейсом на Bubble Tea. |
4 | 4 | **Ничего ставить не нужно, кроме `make` и вашей ОС.** |
5 | 5 |
|
| 6 | +> **Просьба:** для корректного отображения интерфейса **всегда разворачивайте терминал на полный экран** (fullscreen). |
| 7 | +> |
| 8 | +> **Мышь:** пока **не поддерживается** — работаю над этим. Используйте клавиатуру (см. ниже). |
| 9 | +
|
| 10 | +--- |
| 11 | + |
6 | 12 | ## Быстрый старт |
7 | 13 |
|
8 | | -```bash |
9 | | -# 1) Запуск сервера |
10 | | -make server # или make run-server / make run — смотрите цели в Makefile |
11 | | -``` |
12 | 14 | # 2) В другом терминале — запуск TUI-клиента |
13 | | -make tui # или make run-tui / make client — по Makefile |
14 | | -Если в вашем Makefile другие имена целей — используйте их. Смысл простой: одна цель стартует сервер, другая — клиент. |
15 | | - |
16 | | -Учётная запись (демо) |
| 15 | +make tui # (или make run-tui — см. Makefile) |
17 | 16 | Войти можно тестовым аккаунтом: |
18 | 17 |
|
19 | 18 | makefile |
20 | 19 | Copy code |
21 | | -Логин: admin |
22 | | -Пароль: admin |
| 20 | +Логин: admin |
| 21 | +Пароль: admin |
23 | 22 | Как пользоваться |
24 | 23 | Загрузка файла (Upload) |
25 | | -В главном меню выберите Upload (стрелки ↑/↓, Enter). |
26 | | - |
27 | | -Выберите файл через встроенный файловый диалог. |
28 | | - |
29 | | -Во время загрузки увидите: |
| 24 | +В главном меню выберите Upload (↑/↓ и Enter). |
30 | 25 |
|
31 | | -прогресс-бар, проценты, |
| 26 | +Укажите файл во встроенном файловом диалоге. |
32 | 27 |
|
33 | | -скорость передачи и ETA, |
| 28 | +Во время загрузки видно прогресс-бар, скорость и ETA; ESC — отмена. |
34 | 29 |
|
35 | | -подсказку ESC — отмена. |
36 | | - |
37 | | -По завершении вернёт в список файлов (FileList). |
| 30 | +После завершения вы вернётесь к списку файлов (FileList). |
38 | 31 |
|
39 | 32 | Скачивание файла (Download) |
40 | 33 | Откройте FileList. |
41 | 34 |
|
42 | | -Стрелками выберите нужный файл, Enter → Download. |
| 35 | +Выберите файл, Enter → Download. |
43 | 36 |
|
44 | | -Прогресс отображается так же, как при upload. |
| 37 | +Прогресс отображается так же, как при загрузке. |
45 | 38 |
|
46 | | -Готовый файл сохраняется рядом с приложением (в текущей папке, где запущен клиент/бинарь). |
| 39 | +Файл сохраняется рядом с приложением (в текущей директории запуска клиента). |
47 | 40 |
|
48 | | -Если не уверены, где окажется файл — посмотрите текущую директорию (pwd на macOS/Linux или cd без аргументов в Windows). |
| 41 | +Где окажется файл: это текущая папка процесса (pwd на macOS/Linux или просто cd в Windows). |
49 | 42 |
|
50 | | -Клавиши |
51 | | -↑ / ↓ / j / k — навигация по меню/таблицам |
| 43 | +Управление (клавиатура) |
| 44 | +↑ / ↓ / j / k — навигация |
52 | 45 |
|
53 | | -Enter — выбрать |
| 46 | +Enter — выбрать/подтвердить |
54 | 47 |
|
55 | 48 | ESC — назад/отмена/снять фокус |
56 | 49 |
|
57 | 50 | Ctrl+C — выход |
58 | 51 |
|
59 | | -Во время загрузки/скачивания: |
| 52 | +Во время upload/download: ESC — отменить операцию |
60 | 53 |
|
61 | | -ESC — отменить операцию |
| 54 | +Мышь временно не работает — поддержка в разработке. |
62 | 55 |
|
63 | | -Что внутри (коротко) |
64 | | -gRPC сервер и TUI-клиент. |
| 56 | +Сборка под платформы |
| 57 | +Цели Makefile для сборки бинарей: |
65 | 58 |
|
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 | +Примеры: |
67 | 66 |
|
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.) |
69 | 74 |
|
70 | 75 | Демо-видео |
71 | | -В качестве примера можно взять видео с Дуэйном Джонсоном (The Rock): |
| 76 | +В качестве тестового файла можно взять видео с Дуэйном Джонсоном (The Rock): |
72 | 77 | https://www.youtube.com/watch?v=skeQ9C7JuG4 |
73 | 78 |
|
74 | 79 | Траблшутинг |
75 | | -“Висит загрузка” — убедитесь, что сервер запущен до старта клиента. |
| 80 | +“Загрузка/скачивание висит” — убедитесь, что сервер запущен до клиента. |
| 81 | + |
| 82 | +“Не логинится” — проверьте демо-учётку admin/admin. |
76 | 83 |
|
77 | | -“Не логинится” — проверьте демо-логин/пароль admin/admin. |
| 84 | +“Не вижу скачанный файл” — проверьте текущую директорию клиента; файл сохраняется рядом с бинарём. |
78 | 85 |
|
79 | | -“Не вижу скачанного файла” — проверьте текущую директорию клиента; файл сохраняется рядом с бинарём. |
| 86 | +“TUI едет/обрезается” — разверните терминал на полный экран. |
0 commit comments