SOGS 命令速查(Session Open Group / PySOGS)
适用场景:你采用非 Docker 方式安装的 sogs-standalone,需要一份可保存/可打印的管理命令手册。
小提示:
sogs help不是正确用法。正确查看帮助:
sogs -h sogs --help
1. 常用命令一览(按功能)
1.1 初始化 / 升级 / 检查
首次安装后初始化(一般只需一次):
sogs --initialize
升级数据结构(程序提示需要时才执行):
sogs --upgrade
检查升级(只检查不改动):
sogs --check-upgrades
1.2 房间管理
列出房间:
sogs --list-rooms
创建房间(最常用):
sogs --add-room <TOKEN> --name "<NAME>" --description "<DESC>"
示例:
sogs --add-room fishing --name "Fish Talk" --description "Chat about fishing"
删除房间:
sogs --delete-room <TOKEN>
说明:
TOKEN通常建议使用小写字母/数字/短横线/下划线的短字符串。
1.3 全局管理员 / 版主管理
列出全局版主 / 管理员:
sogs --list-global-mods
添加全局版主:
sogs --add-moderators <SESSIONID> [<SESSIONID> ...]
删除全局版主:
sogs --delete-moderators <SESSIONID> [<SESSIONID> ...]
重要:
- 你用于权限管理的 ID 可能是该社区对应的 blinded Session ID。
- 如果你不确定,优先让对方提供“用于该社区管理的 ID”。
1.4 指定房间范围(--rooms)
很多命令可以指定作用范围。
对单个房间:
sogs --rooms <TOKEN>
对多个房间:
sogs --rooms <TOKEN1> <TOKEN2> <TOKEN3>
对所有房间(常见用法):
sogs --rooms *
对全局范围(某些版本支持的惯用做法):
sogs --rooms +
1.5 可见性(配合版主/管理员)
设置可见:
sogs --visible
设置隐藏:
sogs --hidden
通常与添加/删除版主一起用。
1.6 用户权限(临时/细粒度控制)
1.6.1 指定目标用户
对某些命令,需要先指定用户:
sogs --users <SESSIONID> [<SESSIONID> ...]
1.6.2 权限字母说明(常见)
ADD_PERMS / REMOVE_PERMS / CLEAR_PERMS 接收权限字符串。
常见权限:
r读w写u上传附件a访问/加入
默认通常为 rwua。
1.6.3 添加权限
给某用户在某房间增加权限(常见:开放上传):
sogs --rooms <TOKEN> --users <USER_SESSION_ID> --add-perms u
给某用户增加读写:
sogs --rooms <TOKEN> --users <USER_SESSION_ID> --add-perms rw
1.6.4 移除权限
禁止普通用户上传(对某房间):
sogs --rooms <TOKEN> --remove-perms u
禁止普通用户上传(对所有房间):
sogs --rooms * --remove-perms u
做“公告/只读群”效果(普通成员仅保留读+访问):
sogs --rooms <TOKEN> --add-perms ra --remove-perms wu
1.6.5 清空权限覆盖
清空指定用户的权限覆盖设置:
sogs --rooms <TOKEN> --users <USER_SESSION_ID> --clear-perms rwua
说明:
--clear-perms的具体写法以你实际版本为准;
如果版本对该参数有差异,先sogs --help查看。
2. 通用控制参数
显示更详细输出:
sogs --verbose
对需要确认的操作自动回答“是”:
sogs --yes
常用组合示例:
sogs --delete-room oldroom --yes --verbose
3. 你可以直接复制用的“管理模板”
3.1 新建房间并立刻设置权限策略
# 1) 建房
sogs --add-room news --name "Announcements" --description "Official announcements"
# 2) 设为只读普通成员
sogs --rooms news --add-perms ra --remove-perms wu
# 3) 禁止附件(可选)
sogs --rooms news --remove-perms u
3.2 给特定用户开放上传
sogs --rooms media --users <USER_SESSION_ID> --add-perms u
3.3 全局禁附件 + 给白名单开放
# 全局移除上传
sogs --rooms * --remove-perms u
# 给某用户开放
sogs --rooms * --users <USER_SESSION_ID> --add-perms u
4. 快速帮助与自检
查看版本:
sogs --version
查看完整帮助:
sogs -h
列出房间:
sogs --list-rooms
列出全局版主:
sogs --list-global-mods
评论区