A Matrix Synapse administration CLI. Better than typing curl requests!
If you have used axon please provide your feedback, positive or negative. Feel free to open an issue or leave a message in the [matrix] room at #axon:matrix.thisisjoes.site.
In particular, feedback on command usability and desired functionality would be valuable.
Download axon.sh from the releases page.
Mark it as executable: chmod +x axon.sh.
Each release is signed with the project signing key.
To verify the signature, download axon.sh.asc and run gpg --verify axon.sh.asc axon.sh.
Clone and enter the repo directory:
git clone https://git.thisisjoes.site/joe/axon.sh && cd axon.sh
Use the provided copy of LINAC to build axon:
./utils/linac build axon.sh
LINAC will output the result at build/axon.sh.
Start axon and you will be presented with the axon prompt.
Type login to login to an account using your MXID.
Type help for usage info.
If your environment does not support homeserver discovery, you may configure axon.sh directly by using the config command.
See manual configuration on the wiki for more guidance.
- logging in with MXID
- invalidating session on logout
- sending server notices to one or many users
- getting server version information
- getting event reports
- getting connection details about federation destinations
- resetting the connection timeout for federation destinations
- getting server software and version information from federation destinations
- federation destination discovery using .well-known files
- resolving room aliases to their associated ID
- creating new room aliases
- deleting room aliases
- adding rooms to the public directory
- removing rooms from the public directory
- purging local and remote room history
- evacuating users from rooms
- migrating users from evacuated rooms to a new room
- blocking users from joining rooms
- getting details about forward extremities
- deleting forward extremities
- getting list of joined rooms for users
- looking up user by third-party ID (3PID)
- resetting password for users
- creating new users
- deactivating users
- shadowbanning users
- redacting all of a user's events
- managing ratelimits for users