diff --git a/README.md b/README.md index 8ad66fca..f9e0a176 100644 --- a/README.md +++ b/README.md @@ -216,73 +216,7 @@ pip install . ## Implementation Status / Commands List -[Follow this link to the official Synapse Admin API docs](https://element-hq.github.io/synapse/develop/usage/administration/admin_api/index.html) - direct links to the specific API documentation pages are provided in the list below. - -*Note: Most commands have several optional arguments available. Put -h after any of the below listed commands to view them or have a look at the [Command Line Reference](https://synadm.readthedocs.io/en/latest/index_cli_reference.html).* - - -* [ ] [Account Validity](https://element-hq.github.io/synapse/develop/admin_api/account_validity.html) -* [x] [Delete Group](https://element-hq.github.io/synapse/develop/admin_api/delete_group.html) (delete community) -* [ ] [Event Reports](https://element-hq.github.io/synapse/develop/admin_api/event_reports.html) -* [x] [Media Admin](https://element-hq.github.io/synapse/develop/admin_api/media_admin_api.html) - * [x] `media list -r ` - * [x] `media list -u ` (alias of `user media `) - * [x] `media quarantine -s -i ` - * [x] `media quarantine -r ` - * [x] `media quarantine -u ` - * [x] `media protect ` - * [x] `media delete -s -i ` - * [x] `media delete -s --before --size 1024` - * [x] `media purge --before ` (purge remote media API) -* [x] [Purge History](https://element-hq.github.io/synapse/develop/admin_api/purge_history_api.html) - * [x] `history purge ` - * [x] `history purge-status ` -* [x] ~~[Purge Rooms](https://element-hq.github.io/synapse/develop/admin_api/purge_room.html)~~ (DEPRECATED, covered by `room delete`) -* [ ] [Register Users](https://element-hq.github.io/synapse/develop/admin_api/register_api.html) -* [x] [Manipulate Room Membership](https://element-hq.github.io/synapse/develop/admin_api/room_membership.html) - * [x] `room join` -* [x] [Rooms](https://element-hq.github.io/synapse/develop/admin_api/rooms.html) - * [x] `room list` - * [x] `room details ` - * [x] `room members ` - * [x] `room delete ` - * [x] `room make-admin ` - * [x] `room state ` - * [ ] Additional commands and aliases around room management - * [x] `room search ` (alias of `room list -n `) - * [x] `room resolve ` - * [x] `room power-levels` - * [x] `room block` - * [x] `room block-status` -* [x] [Server Notices](https://element-hq.github.io/synapse/develop/admin_api/server_notices.html) -* [x] ~~[Shutdown Room](https://element-hq.github.io/synapse/develop/admin_api/shutdown_room.html)~~ (DEPRECATED, covered by `room delete`) -* [ ] [Statistics](https://element-hq.github.io/synapse/develop/admin_api/statistics.html) - * [ ] `synadm media user-stats` - * [ ] `synadm room largest` -* [x] [Users](https://element-hq.github.io/synapse/develop/admin_api/user_admin_api.html) - * [x] `user details ` - * [x] `user modify ` (also used for user creation) - * [x] `user list` - * [x] `user deactivate ` (including GDPR erase) - * [x] `user password ` - * [x] `user membership ` - * [x] `user whois ` - * [x] `user shadow-ban ` - * [x] `user media -u ` (also available as `media list -u `) - * [x] `user login ` - * [ ] Additional commands and aliases around user management - * [x] `user search ` (shortcut to `user list -d -g -n `) - * [ ] `user create ` (alias of `user modify ...`) - * [x] `user prune-devices ` -* [x] [Server Version](https://element-hq.github.io/synapse/develop/admin_api/version_api.html) - * [x] `version` -* [x] [Registration Tokens](https://element-hq.github.io/synapse/latest/usage/administration/admin_api/registration_tokens.html) - * [x] `regtok list` - * [x] `regtok details ` - * [x] `regtok new` - * [x] `regtok update ` - * [x] `regtok delete ` - +The [API to CLI Mapping](https://synadm.readthedocs.io/en/dev/features.html) section of our documentation provides an overview of what `synadm` can do. ## Get in Touch @@ -301,4 +235,4 @@ If you are sure you've found a bug that was not already reported, certainly dire First of all, thanks for your interest in contributing to `synadm`! We appreciate any help, no matter if you are a programmer or a user. Both groups can do valuable things for the `synadm` project. We love providing a useful tool to fellow Synapse sysadmins but rely on contribution from the Synapse and Matrix community to keep `synadm` useful, current and stable. -Please review the [contributing docs](CONTRIBUTING.md) for guidelines and help around the topic! +Please review the [contributing docs](CONTRIBUTING.md) for guidelines and help around the topic! \ No newline at end of file