From aeae198d0effc1e2acb325b97b2c5e2d540c8305 Mon Sep 17 00:00:00 2001 From: Noah Gao Date: Sun, 6 Sep 2026 02:57:35 +0800 Subject: [PATCH] docs: fix manage command positional arguments --- docs/reference/cli/manage.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/reference/cli/manage.md b/docs/reference/cli/manage.md index 52b5d3598..0117a9638 100644 --- a/docs/reference/cli/manage.md +++ b/docs/reference/cli/manage.md @@ -64,12 +64,15 @@ $ mas-cli manage set-password --ignore-complexity Issue a compatibility token for a user. +Arguments: +- ``: User for which to issue the token. +- `[device_id]`: Device ID to set in the token. If not specified, a random device ID will be generated. + Options: -- `--device-id `: Device ID to set in the token. If not specified, a random device ID will be generated. - `--yes-i-want-to-grant-synapse-admin-privileges`: Whether the token should be given admin privileges. ``` -$ mas-cli manage issue-compatibility-token --device-id --yes-i-want-to-grant-synapse-admin-privileges +$ mas-cli manage issue-compatibility-token --yes-i-want-to-grant-synapse-admin-privileges ``` ## `manage issue-user-registration-token` @@ -131,8 +134,10 @@ $ mas-cli manage unlock-user --reactivate Register a user. This will interactively prompt for the user's attributes unless the `--yes` flag is set. It bypasses any policy check on the password, email, etc. +Arguments: +- `[username]`: Username to register. Required when using `--yes`. + Options: -- `--username `: Username to register. - `--password `: Password to set. - `--email `: Email to add. Can be specified multiple times. - `--upstream-provider-mapping `: Upstream OAuth 2.0 provider mapping. Can be specified multiple times. @@ -144,4 +149,5 @@ Options: ``` $ mas-cli manage register-user +$ mas-cli manage register-user --yes ```