2183d8f849
CLI_tasks/user.md: Fix `pleroma.user new` documentation Closes #1621 See merge request pleroma/pleroma!2286
3.5 KiB
3.5 KiB
Managing users
{! backend/administration/CLI_tasks/general_cli_task_info.include !}
Create a user
./bin/pleroma_ctl user new <nickname> <email> [option ...]
mix pleroma.user new <nickname> <email> [option ...]
Options
--name <name>- the user's display name--bio <bio>- the user's bio--password <password>- the user's password--moderator/--no-moderator- whether the user should be a moderator--admin/--no-admin- whether the user should be an admin-y,--assume-yes/--no-assume-yes- whether to assume yes to all questions
List local users
./bin/pleroma_ctl user list
mix pleroma.user list
Generate an invite link
./bin/pleroma_ctl user invite [option ...]
mix pleroma.user invite [option ...]
Options
--expires-at DATE- last day on which token is active (e.g. "2019-04-05")--max-use NUMBER- maximum numbers of token uses
List generated invites
./bin/pleroma_ctl user invites
mix pleroma.user invites
Revoke invite
./bin/pleroma_ctl user revoke_invite <token_or_id>
mix pleroma.user revoke_invite <token_or_id>
Delete a user
./bin/pleroma_ctl user rm <nickname>
mix pleroma.user rm <nickname>
Delete user's posts and interactions
./bin/pleroma_ctl user delete_activities <nickname>
mix pleroma.user delete_activities <nickname>
Sign user out from all applications (delete user's OAuth tokens and authorizations)
./bin/pleroma_ctl user sign_out <nickname>
mix pleroma.user sign_out <nickname>
Deactivate or activate a user
./bin/pleroma_ctl user toggle_activated <nickname>
mix pleroma.user toggle_activated <nickname>
Unsubscribe local users from a user and deactivate the user
./bin/pleroma_ctl user unsubscribe NICKNAME
mix pleroma.user unsubscribe NICKNAME
Unsubscribe local users from an instance and deactivate all accounts on it
./bin/pleroma_ctl user unsubscribe_all_from_instance <instance>
mix pleroma.user unsubscribe_all_from_instance <instance>
Create a password reset link for user
./bin/pleroma_ctl user reset_password <nickname>
mix pleroma.user reset_password <nickname>
Set the value of the given user's settings
./bin/pleroma_ctl user set <nickname> [option ...]
mix pleroma.user set <nickname> [option ...]
Options
--locked/--no-locked- whether the user should be locked--moderator/--no-moderator- whether the user should be a moderator--admin/--no-admin- whether the user should be an admin
Add tags to a user
./bin/pleroma_ctl user tag <nickname> <tags>
mix pleroma.user tag <nickname> <tags>
Delete tags from a user
./bin/pleroma_ctl user untag <nickname> <tags>
mix pleroma.user untag <nickname> <tags>
Toggle confirmation status of the user
./bin/pleroma_ctl user toggle_confirmed <nickname>
mix pleroma.user toggle_confirmed <nickname>