frienden 0.10.0__tar.gz

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.
@@ -0,0 +1,382 @@
1
+ Metadata-Version: 2.4
2
+ Name: frienden
3
+ Version: 0.10.0
4
+ Summary: FRIENDEN CLI and browser-based OAuth SDK for other command-line apps
5
+ Author: FRIENDEN
6
+ Project-URL: Homepage, https://frienden.jyonn.space
7
+ Project-URL: Source, https://github.com/Jyonn/Sermo-CLI
8
+ Keywords: frienden,sermo,chat,cli,oauth,pkce
9
+ Classifier: Development Status :: 3 - Alpha
10
+ Classifier: Environment :: Console
11
+ Classifier: Intended Audience :: End Users/Desktop
12
+ Classifier: Natural Language :: Chinese (Simplified)
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3 :: Only
15
+ Classifier: Programming Language :: Python :: 3.10
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Topic :: Communications :: Chat
19
+ Requires-Python: >=3.10
20
+ Description-Content-Type: text/markdown
21
+ Requires-Dist: Pillow<13,>=10
22
+
23
+ # FRIENDEN 友间 CLI
24
+
25
+ 原 PyPI 包 `sermo` 已迁移为 `frienden`。原有聊天和账户命令保留,并新增面向其他 CLI 的 OAuth 登录 SDK。
26
+
27
+ FRIENDEN 友间的命令行客户端。朋友之间,自有一间。它直接接入现有 `sermo-backend` API,适合在终端里快速查看会话、发送文字消息和检查好友信息。
28
+
29
+ 当前版本覆盖日常终端使用:
30
+
31
+ - 支持进入空间并保存登录状态。
32
+ - 支持查看当前账户、空间成员、聊天列表、好友列表、好友申请。
33
+ - 支持查看聊天记录、发送文字消息、持续刷新新消息、监听全局新消息。
34
+ - 默认提供不清屏的局部窗口选择器,会话、好友、成员和申请列表只展示光标附近 5 项。
35
+ - 保留 `frienden tui` 全屏终端聊天界面,会话列表、消息流和输入框集中展示。
36
+ - 支持好友申请处理、好友邀请链接、私聊打开、群聊创建和成员管理。
37
+ - 支持账号资料、联系方式绑定、通知偏好、空间创建和管理员基础操作。
38
+ - 图片、视频封面与表情包会在终端中生成轻量字符缩略图;文件、语音、位置、足迹、广场卡片、活动和合并聊天记录使用结构化预览。
39
+ - 支持发送图片、视频、语音、文件、精确/模糊位置和表情包,并支持消息搜索、转发、置顶、撤回、仅自己删除与清空本地会话历史。
40
+ - 暂不展示头像。
41
+
42
+ ## 安装
43
+
44
+ 开发环境下可以直接运行:
45
+
46
+ ```bash
47
+ python -m frienden --help
48
+ ```
49
+
50
+ 也可以安装为本地命令:
51
+
52
+ ```bash
53
+ pip install -e .
54
+ frienden --help
55
+ ```
56
+
57
+ 从 PyPI 安装:
58
+
59
+ ```bash
60
+ pip install frienden
61
+ frienden --help
62
+ ```
63
+
64
+ ## API 地址
65
+
66
+ 默认 API 地址是:
67
+
68
+ ```text
69
+ https://api.sermo.jyonn.space
70
+ ```
71
+
72
+ 可以用环境变量或参数覆盖:
73
+
74
+ ```bash
75
+ FRIENDEN_API_BASE=http://localhost:8000 python -m frienden chats
76
+ python -m frienden --api http://localhost:8000 chats
77
+ ```
78
+
79
+ ## 常用命令
80
+
81
+ 登录 / 进入空间:
82
+
83
+ ```bash
84
+ frienden login --space yuanmeng --name 软糖大啾咪
85
+ ```
86
+
87
+ 如果昵称需要访问密码,CLI 会自动提示输入密码。
88
+
89
+ 查看当前账户:
90
+
91
+ ```bash
92
+ frienden me
93
+ ```
94
+
95
+ 查看聊天列表:
96
+
97
+ ```bash
98
+ frienden chats
99
+ ```
100
+
101
+ 终端中会显示光标附近 5 个会话。使用 `↑/↓` 选择、`Enter` 打开、`Esc` 返回;也支持 `j/k` 和 `Ctrl+N/Ctrl+P`。
102
+
103
+ 直接输出完整列表,适合管道和脚本:
104
+
105
+ ```bash
106
+ frienden chats --list
107
+ ```
108
+
109
+ 调整局部窗口行数:
110
+
111
+ ```bash
112
+ frienden chats --window 7
113
+ ```
114
+
115
+ 打开 TUI:
116
+
117
+ ```bash
118
+ frienden tui
119
+ ```
120
+
121
+ 在 TUI 里:
122
+
123
+ - `Tab/Shift+Tab` 在会话、消息和输入框之间切换焦点。
124
+ - 会话焦点下使用 `↑/↓` 或 `j/k` 切换会话。
125
+ - 消息焦点下使用 `↑/↓` 滚动,`PageUp/PageDown` 翻页,滑到顶部自动加载历史。
126
+ - 在任意区域按 `Ctrl+F` 搜索当前聊天记录,选择结果后加载并定位上下文。
127
+ - 查看历史时不会强制跳到底部;标题会提示新消息数量,`End` 回到最新消息。
128
+ - 输入框支持左右移动、`Home/End`、退格与 Delete,并按会话保存草稿。
129
+ - 发送消息会立即展示“发送中”;失败后保留消息,在消息焦点按 `r` 重试。
130
+ - `Enter` 发送,`F5` 手动刷新,`Ctrl+U` 清空输入。
131
+ - `Esc` 或 `F10` 退出。
132
+
133
+ 会话焦点还支持:
134
+
135
+ - `/` 按会话名称或最后一条消息搜索。
136
+ - `u` 只看未读会话,`x` 清除全部筛选。
137
+ - `i` 查看当前会话资料。
138
+ - 连续五分钟内同一用户的消息自动合并显示昵称与时间。
139
+ - 终端宽度不足 86 列时自动切换为单栏布局。
140
+
141
+ 消息与输入增强:
142
+
143
+ - `Ctrl+K` 打开可搜索的命令面板。
144
+ - 消息焦点按 `v` 进入选择模式,使用 `↑/↓` 选择消息。
145
+ - 选择消息后按 `q` 引用、`c` 复制、`d` 删除,删除前会二次确认。
146
+ - 引用摘要会显示在输入框上方,按 `Esc` 取消引用。
147
+ - 输入框按 `Ctrl+O` 插入换行,最多展示 4 行;`Enter` 仍用于发送。
148
+ - 选择消息后按 `o` 打开附件、`p` 置顶/取消置顶、`h` 仅为自己删除。
149
+ - 输入 `/image`、`/video`、`/audio`、`/file`、`/sticker` 或 `/location` 可直接从 TUI 发送对应内容,输入 `/help` 查看格式。
150
+ - 按 `Ctrl+G` 打开发送内容面板,按 `Ctrl+E` 打开带字符预览的“我的表情/探索表情”选择器。
151
+ - 在会话列表或消息区按 `s` 管理置顶、通知静音、未读角标、动态提醒与上线提醒。
152
+ - TUI 同时展示普通聊天和投稿会话;投稿消息按回合分幕,并明确标记当前仅本方可见的内容和发送权限。
153
+
154
+ 打开聊天:
155
+
156
+ ```bash
157
+ frienden chat 1
158
+ ```
159
+
160
+ 在聊天界面里:
161
+
162
+ - 直接输入文字并回车即可发送。
163
+ - 输入 `/refresh` 刷新新消息。
164
+ - 输入 `/quit` 退出。
165
+
166
+ 只发送一条消息:
167
+
168
+ ```bash
169
+ frienden send 1 你好
170
+ ```
171
+
172
+ 持续刷新聊天:
173
+
174
+ ```bash
175
+ frienden chat 1 --follow
176
+ ```
177
+
178
+ 查看好友:
179
+
180
+ ```bash
181
+ frienden friends
182
+ ```
183
+
184
+ 好友、空间成员、好友申请和群聊邀请使用同一套局部窗口交互:
185
+
186
+ ```bash
187
+ frienden friends
188
+ frienden users
189
+ frienden requests
190
+ frienden group invites
191
+ ```
192
+
193
+ 这些命令也都支持 `--list` 和 `--window`。
194
+
195
+ 查看好友申请:
196
+
197
+ ```bash
198
+ frienden requests
199
+ ```
200
+
201
+ 接受/忽略好友申请:
202
+
203
+ ```bash
204
+ frienden friend accept <user_id_or_name>
205
+ frienden friend ignore <user_id_or_name>
206
+ ```
207
+
208
+ 打开私聊:
209
+
210
+ ```bash
211
+ frienden direct <user_id_or_name> --open
212
+ ```
213
+
214
+ 监听所有新消息:
215
+
216
+ ```bash
217
+ frienden watch
218
+ ```
219
+
220
+ 加载更早消息:
221
+
222
+ ```bash
223
+ frienden chat 1 --before <message_id>
224
+ ```
225
+
226
+ 群聊:
227
+
228
+ ```bash
229
+ frienden group create 12 34 --title 周末计划
230
+ frienden group add 1 56
231
+ frienden group rename 1 新群名
232
+ frienden group leave 1
233
+ frienden group owner 1 新群主昵称
234
+ frienden group mute 1 用户昵称 --duration 1h
235
+ frienden group mute 1 用户昵称 --remove
236
+ ```
237
+
238
+ 回合制投稿:
239
+
240
+ ```bash
241
+ frienden submission recipients
242
+ frienden submission start 运营昵称 "投稿标题" "第一条草稿消息"
243
+ frienden submission list --role author
244
+ frienden submission submit 12
245
+ frienden submission revision 12
246
+ frienden submission terminate 12
247
+ frienden submission ready 12
248
+ frienden submission withdraw 12
249
+ frienden submission invite 12 协作者昵称 --role author
250
+ ```
251
+
252
+ 发送媒体消息:
253
+
254
+ ```bash
255
+ frienden message media 1 ./photo.jpg
256
+ frienden message media 1 ./voice.m4a --kind audio --duration 8
257
+ frienden message media 1 ./report.pdf
258
+ frienden message location 1 30.2741 120.1551 --obscure
259
+ frienden message stickers --explore
260
+ frienden message sticker 1 42
261
+ ```
262
+
263
+ 搜索、转发与管理消息:
264
+
265
+ ```bash
266
+ frienden message search 1 关键词 --type 0
267
+ frienden message forward 101 102 --to 2 3 --mode bundle
268
+ frienden message pin 101
269
+ frienden message delete 101 --scope me
270
+ frienden message clear 1
271
+ frienden message calendar 1 2026 9
272
+ frienden message transcript 101 --create
273
+ frienden message resources --kind file --keyword 报告
274
+ frienden message recovery 1
275
+ frienden message events --after 0
276
+ ```
277
+
278
+ 在 TUI 的消息选择模式中按 `t`,可以查看缓存的语音转写或发起一次转写。
279
+
280
+ 广场与足迹:
281
+
282
+ ```bash
283
+ frienden square list --scope friends --keyword 周末
284
+ frienden square show 18
285
+ frienden square post "今天也要见朋友。" --visibility friends
286
+ frienden square comments 18 --sort hot
287
+ frienden square comment 18 "一起去" --parent 42
288
+ frienden square like 18
289
+ frienden map show
290
+ frienden map show 好友昵称
291
+ frienden map check-in 30.2741 120.1551 --region-code CN-ZJ --region-name 浙江 --country-code CN --country-name 中国
292
+ frienden map access --chat-id 3 --change
293
+ frienden map access 好友昵称
294
+ ```
295
+
296
+ 成长、活动与通知:
297
+
298
+ ```bash
299
+ frienden activity list
300
+ frienden activity show summer
301
+ frienden activity claim summer --reward milestone --reward-key m2
302
+ frienden activity contribute summer
303
+ frienden growth show
304
+ frienden growth discoveries
305
+ frienden growth emojis
306
+ frienden sticker collect --asset-id 42
307
+ frienden notify topics
308
+ frienden notify events --unread
309
+ frienden account private on
310
+ ```
311
+
312
+ 好友邀请链接:
313
+
314
+ ```bash
315
+ frienden invite token --permanent
316
+ frienden invite redeem <token>
317
+ ```
318
+
319
+ 账号与通知:
320
+
321
+ ```bash
322
+ frienden account password
323
+ frienden account name 新昵称
324
+ frienden account welcome "欢迎来找我聊天"
325
+ frienden account welcome-messages
326
+ frienden account welcome-messages --file welcome-messages.json
327
+ frienden account switch
328
+ frienden account switch 42
329
+ frienden account personalization --bubble comic --frame polaroid --show-self-avatar on
330
+ frienden account upload avatar ~/Pictures/avatar.png
331
+ frienden account upload background ~/Pictures/chat-bg.jpg
332
+ frienden account language system --system-language zh-CN
333
+ frienden contact code email you@example.com
334
+ frienden contact bind email you@example.com 123456
335
+ frienden notify list
336
+ frienden notify set bark --enabled on --threshold 1 --hide-content on
337
+ ```
338
+
339
+ 空间与管理员:
340
+
341
+ ```bash
342
+ frienden space email-code --slug yuanmeng
343
+ frienden space admin-login --space yuanmeng --email admin@example.com --code 123456
344
+ frienden admin dashboard
345
+ frienden admin users
346
+ frienden admin operator 42 on
347
+ frienden admin chat-mute 42 1h
348
+ frienden admin chat-mute 42 --remove
349
+ frienden admin square-mute --list
350
+ frienden admin square-mute 42 --duration 7d --reason 刷屏
351
+ frienden admin settings --square off --member-limit 100
352
+ frienden admin official-ticket
353
+ ```
354
+
355
+ 退出:
356
+
357
+ ```bash
358
+ frienden logout
359
+ ```
360
+
361
+ ## 登录状态
362
+
363
+ 登录状态默认保存到:
364
+
365
+ ```text
366
+ ~/.frienden/config.json
367
+ ```
368
+
369
+ 可以用 `FRIENDEN_CLI_CONFIG` 指定其他路径,便于测试或多账号切换。
370
+
371
+
372
+ ## 其他 CLI 使用 FRIENDEN 登录
373
+
374
+ 使用 `from frienden.oauth import OAuthClient`,或运行 `frienden oauth login --help`。
375
+ 详见 [OAuth CLI 接入指南](https://github.com/Jyonn/Sermo-CLI/blob/main/docs/oauth-cli.md)。每个应用使用自己的已审批 client_id 和本机回调,用户通过浏览器确认授权。
376
+
377
+ ## 从 Sermo 迁移
378
+
379
+ `pip install -U frienden` 安装新的 `frienden` 命令。旧的登录配置会一次性从 `~/.sermo-cli/config.json` 导入到 `~/.frienden/config.json`,不会删除原文件。
380
+ 新环境变量优先,旧的 `SERMO_API_BASE` 和 `SERMO_CLI_CONFIG` 仍兼容。退出登录会保留空配置,避免重新导入旧会话。
381
+
382
+ `pip install -U sermo` 安装兼容包,自动依赖 Frienden,保留 `sermo` 和 `python -m sermo_cli`。两个发行包提供不同文件,不互相覆盖。