@ih8e/express-cli 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +124 -0
- package/dist/index.js +4056 -0
- package/dist/index.js.map +1 -0
- package/package.json +54 -0
package/README.md
ADDED
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
# express-cli
|
|
2
|
+
|
|
3
|
+
Неофициальный клиент корпоративного мессенджера **eXpress** с тремя интерфейсами:
|
|
4
|
+
|
|
5
|
+
- **CLI** — команды для скриптов и агентов (`express-cli chats`, `send`, `messages`, …);
|
|
6
|
+
- **TUI** — интерактивный терминальный интерфейс (список чатов, треды, отправка);
|
|
7
|
+
- **MCP-сервер** — инструменты для AI-агентов (любой MCP-совместимый клиент).
|
|
8
|
+
|
|
9
|
+
Всё общение сквозным шифрованием (E2E): nacl.box для ключей + XChaCha20-Poly1305 для тела.
|
|
10
|
+
|
|
11
|
+
> ⚠️ Внутренний инструмент. HAR-файлы, дампы трафика и токены **не коммитятся** (см. `.gitignore`).
|
|
12
|
+
|
|
13
|
+
## Требования
|
|
14
|
+
|
|
15
|
+
- **Node.js ≥ 22** (используется глобальный `WebSocket`).
|
|
16
|
+
- Аккаунт eXpress и мобильное приложение для входа по QR.
|
|
17
|
+
|
|
18
|
+
## Установка
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npm install
|
|
22
|
+
npm run setup # собирает и делает команду express-cli глобальной (build + npm link)
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
После этого доступна команда `express-cli`:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
express-cli --help
|
|
29
|
+
express-cli auth qr
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Отдельные шаги, если нужно: `npm run build` (только сборка, `tsup → dist/index.js`),
|
|
33
|
+
затем `npm link` (глобальная команда) или запуск напрямую — `node ./dist/index.js <команда>`.
|
|
34
|
+
|
|
35
|
+
> Ниже примеры используют глобальную команду `express-cli`. Без глобальной установки
|
|
36
|
+
> замените её на `node ./dist/index.js`.
|
|
37
|
+
|
|
38
|
+
## Аутентификация
|
|
39
|
+
|
|
40
|
+
Вход — по QR-коду (сканируется мобильным приложением eXpress):
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
express-cli auth qr # показывает QR, ждёт скан
|
|
44
|
+
express-cli auth status # статус токена
|
|
45
|
+
express-cli auth refresh # обновить токен (ключи не трогает)
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
При QR-логине CLI получает **общий cts-ключ аккаунта** прямо из QR-обмена (как телефон/десктоп), поэтому расшифровка работает сразу — без ручного импорта.
|
|
49
|
+
|
|
50
|
+
> Важно: не запускайте `auth qr` без нужды на разных устройствах бесконтрольно — модель ключей рассчитана на один общий cts-ключ на аккаунт. Подробности и все нюансы E2E — в [`AGENTS.md`](./AGENTS.md).
|
|
51
|
+
|
|
52
|
+
## CLI
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
express-cli chats list [--type dm|group|channel] # список чатов (ФИО для личек)
|
|
56
|
+
express-cli chats find "Иванов" # найти чат → полный UUID
|
|
57
|
+
express-cli messages list <chat-id> [--limit N] # прочитать и расшифровать
|
|
58
|
+
express-cli send message "Иванов" "Привет!" # отправить (по имени или UUID)
|
|
59
|
+
express-cli send file "Иванов" ./report.pdf # отправить файл
|
|
60
|
+
express-cli contacts search "Петров" # глобальный поиск сотрудников
|
|
61
|
+
express-cli contacts self # свой профиль
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Большинство команд поддерживают `--output json` для пайплайнов.
|
|
65
|
+
|
|
66
|
+
## TUI
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
express-cli tui
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
- слева — список чатов (непрочитанные, ФИО в личках), справа — тред, снизу — ввод;
|
|
73
|
+
- **↑/↓** — чаты, **→** — войти в тред, **Enter** — писать, **q** — выход;
|
|
74
|
+
- **t** — панель обсуждений (тредов) чата; **Enter** — открыть обсуждение;
|
|
75
|
+
- mentions рендерятся как `@Имя`, картинки — как `🖼 file` + блок-арт превью под курсором.
|
|
76
|
+
|
|
77
|
+
## MCP-сервер
|
|
78
|
+
|
|
79
|
+
Запускается по stdio, переиспользует тот же E2E-код, что CLI/TUI.
|
|
80
|
+
|
|
81
|
+
Команда запуска для любого MCP-клиента (stdio transport):
|
|
82
|
+
```
|
|
83
|
+
express-cli mcp
|
|
84
|
+
# или без глобальной установки:
|
|
85
|
+
node /абсолютный/путь/dist/index.js mcp
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Инструменты: `chats_list`, `chats_find`, `messages_list`, `send_message`,
|
|
89
|
+
`contacts_search`, `contacts_self`, `wait_for_messages`, `status`.
|
|
90
|
+
`wait_for_messages` блокируется до новых входящих (для реакции без поллинга).
|
|
91
|
+
|
|
92
|
+
## Архитектура
|
|
93
|
+
|
|
94
|
+
```
|
|
95
|
+
src/
|
|
96
|
+
api/ HTTP + WebSocket клиенты, E2E крипта (decrypt.ts), резолв имён
|
|
97
|
+
auth/ QR-логин, обновление токена, ключи
|
|
98
|
+
session/ персистентная WS-сессия (чаты, треды, live-пуши) — для TUI/MCP
|
|
99
|
+
cli/ команды (commander)
|
|
100
|
+
tui/ интерфейс на Ink + React
|
|
101
|
+
mcp/ MCP-сервер над api-слоем
|
|
102
|
+
config/ хранение токенов/ключей (conf), настройки
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Токены и ключи хранятся локально через `conf` (вне репозитория, в конфиге ОС),
|
|
106
|
+
в код и git не попадают.
|
|
107
|
+
|
|
108
|
+
## Разработка
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
npm run build # сборка (tsup)
|
|
112
|
+
npm run dev # watch-сборка
|
|
113
|
+
npm run lint # tsc --noEmit (есть остаточные предупреждения типов)
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
Глубокая техническая документация по протоколу eXpress, модели ключей и E2E —
|
|
117
|
+
в [`AGENTS.md`](./AGENTS.md).
|
|
118
|
+
|
|
119
|
+
## Безопасность
|
|
120
|
+
|
|
121
|
+
- E2E: приватные ключи и токены — только локально (`conf`), никогда в git.
|
|
122
|
+
- HAR-файлы и дампы трафика содержат токены/ключи/личные данные — они в `.gitignore`.
|
|
123
|
+
- Один активный cts-ключ на аккаунт; свежий `auth qr`/логин на новом устройстве
|
|
124
|
+
забирает общий ключ через QR-обмен (детали — в `AGENTS.md`).
|