petrichor/mxadm: A simple CLI interface to basic Matrix room admin tasks - mxadm - tildegit This website works better with JavaScript. Home Explore Drone CI Help Register Sign In petrichor / mxadm Watch 1 Star 0 Fork 0 Code Issues 1 Pull Requests Projects 1 Releases Activity A simple CLI interface to basic Matrix room admin tasks clirustmatrix You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long. 36 Commits 1 Branch 2 Tags 265 KiB Rust 95.6% Nix 4.4%     Branch: main main v0.1.0 v0.1.1 Branches Tags ${ item.name } Create tag ${ searchTerm } Create branch ${ searchTerm } from 'main' ${ noResults } Compare HTTPS  ZIP  TAR.GZ Jez Cope 007c81015d Version bump: 0.1.2 1 week ago src Tweak usage to show example ID format 1 week ago .gitignore Initial implementation of login and status verbs 2 months ago Cargo.lock Version bump: 0.1.2 1 week ago Cargo.toml Version bump: 0.1.2 1 week ago README.md Flesh out README.md 3 weeks ago envrc.sample Initial commit 3 months ago flake.lock Remove devshell 2 months ago flake.nix flake.nix: add cargo-outdated, cargo-audit 3 weeks ago README.md mxadm: a simple CLI to automate Matrix room admin tasks mxadm is a simple command-line tool to do some basic Matrix room admin tasks, especially things which don't currently have a UI in Element, or which are possible but require a fair bit of effort (e.g. using Element's devtools). It should be considered unstable: the command-line arguments will evolve as the tool itself evolves, but the functionality should roughly the same. Getting started Installation Not yet packaged for any OS as far as I'm aware. You can install it with Rust's cargo tool: Install Rust and Cargo Install mxadm: $ cargo install mxadm Usage The only documentation is currently via the tool itself: $ mxadm help mxadm 0.1.0 Jez Cope 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 Development & contributions See also license info This is a hobby project of mine, developed for my own use case, but I would be delighted if someone else wanted to use it! If you find bugs or want to request new features please feel free to create a new issue (it's running gitea and you can sign in with GitHub or Twitter) but bear in mind that it will probably take me some time to get around to responding or doing something about it! If you want something changing and have the skills, a pull request/patch will probably be quicker, but there will still be delays before I can review and merge it. I'm also pretty new to Rust, so my code may not be the best; constructive code review very welcome! Contact me Matrix: @jez:petrichor.me Fedi: @petrichor@scholar.social Twitter: @jezcope TODO Login and store session info Log out Show login status Tombstone room Add room alias Remove room alias Set canonical room alias Optionally create alias in one command Remove canonical room alias List rooms Filter room list in various ways (esp. Spaces!) Handle multiple accounts on different homeservers Upgrade room Make it easier to script workflows like "configure ACL permissions -> invite mjolnir -> op mjolnir" in multiple rooms License Copyright (C) 2021 Jez Cope This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/. Powered by Gitea Version: 1.14.6 Page: 54ms Template: 9ms English English 简体中文 繁體中文（香港） 繁體中文（台灣） Deutsch français Nederlands latviešu русский Українська 日本語 español português do Brasil Português de Portugal polski български italiano suomi Türkçe čeština српски svenska 한국어 Licenses API Website tildeverse.org Go1.16.7