3 个版本
0.1.2 | 2021 年 8 月 4 日 |
---|---|
0.1.1 | 2021 年 7 月 26 日 |
0.1.0 | 2021 年 7 月 21 日 |
#16 in #room
24KB
281 行
mxadm:一个简单的 CLI,用于自动化 Matrix 房间管理任务
mxadm
是一个简单的命令行工具,用于执行一些基本的 Matrix 房间管理任务,尤其是那些在 Element 中还没有 UI 的任务,或者虽然可能但需要相当多的努力(例如使用 Element 的开发者工具)。
它应被视为不稳定:随着工具本身的发展,命令行参数将会演变,但功能应该大致相同。
入门
安装
据我所知,尚未为任何操作系统打包。您可以使用 Rust 的 cargo
工具安装它
-
安装
mxadm
$ cargo install mxadm
用法
唯一的文档目前是通过工具本身提供
$ mxadm help
mxadm 0.1.0
Jez Cope <j.cope@erambler.co.uk>
A simple CLI interface to basic Matrix room admin tasks
USAGE:
mxadm [SUBCOMMAND]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
SUBCOMMANDS:
alias alias subcommands
help Prints this message or the help of the given subcommand(s)
login authenticates and saves the session details
logout ends the current session
room room subcommands
status displays current session status
开发和贡献
这是我的一项业余项目,为我的特定用例开发的,但如果有人想使用它,我会很高兴!如果您发现错误或希望请求新功能,请随时 创建一个新问题(它运行 gitea,您可以使用 GitHub 或 Twitter 登录),但请注意,我可能需要一些时间才能回复或处理它!如果您想改变某些内容并具备相关技能,提交一个 pull request/patch 可能会更快,但在我审查和合并之前仍会有延迟。
我对于 Rust 也是新手,所以我的代码可能不是最好的;非常欢迎建设性的代码审查!
联系我
- Matrix: @jez:petrichor.me
- Fedi: @[email protected]
- Twitter: @jezcope
TODO
- 登录并存储会话信息
- 登出
- 显示登录状态
- 设置墓碑房间
- 添加房间别名
- 删除房间别名
- 设置规范房间别名
- 可选地在一条命令中创建别名
- 删除规范房间别名
- 列出房间
- 以各种方式过滤房间列表(特别是空间!)
- 处理不同 homeservers 上的多个账户
- 升级房间
- 使在多个房间中执行如 "配置 ACL 权限 -> 邀请 mjolnir -> op mjolnir" 的工作流程更容易脚本化
许可证
版权所有 (C) 2021 Jez Cope
本程序是自由软件:您可以按照自由软件基金会发布的GNU通用公共许可证的条款重新分发和/或修改它,许可证版本可以是3版,也可以是您选择的任何较新版本。
本程序以希望它是有用的目的进行分发,但没有任何保证;甚至没有关于其商业性或特定用途适用性的暗示性保证。有关更多详细信息,请参阅GNU通用公共许可证。
您应该已经收到一份GNU通用公共许可证副本,与该程序一起提供。如果没有,请参阅https://www.gnu.org/licenses/。
依赖项
~19–33MB
~530K SLoC