Skip to content

Commit ff82e82

Browse files
author
Yohann Delafollye
committed
Update the documentation
1 parent d452842 commit ff82e82

File tree

1 file changed

+31
-19
lines changed

1 file changed

+31
-19
lines changed

docs/content/doc/usage/command-line.en-us.md

+31-19
Original file line numberDiff line numberDiff line change
@@ -55,28 +55,40 @@ Starts the server:
5555
Admin operations:
5656

5757
- Commands:
58-
- `create-user`
59-
- Options:
60-
- `--name value`: Username. Required. As of gitea 1.9.0, use the `--username` flag instead.
61-
- `--username value`: Username. Required. New in gitea 1.9.0.
62-
- `--password value`: Password. Required.
63-
- `--email value`: Email. Required.
64-
- `--admin`: If provided, this makes the user an admin. Optional.
65-
- `--access-token`: If provided, an access token will be created for the user. Optional. (default: false).
66-
- `--must-change-password`: If provided, the created user will be required to choose a newer password after
58+
- `user`:
59+
- `list`:
60+
- Options:
61+
- `--admin`: List only admin users. Optional.
62+
- Description: lists all users that exist
63+
- Examples:
64+
- `gitea admin user list`
65+
- `delete`:
66+
- Options:
67+
- `--id`: ID of user to be deleted. Required.
68+
- Examples:
69+
- `gitea admin user delete --id 1`
70+
- `create`:
71+
- Options:
72+
- `--name value`: Username. Required. As of gitea 1.9.0, use the `--username` flag instead.
73+
- `--username value`: Username. Required. New in gitea 1.9.0.
74+
- `--password value`: Password. Required.
75+
- `--email value`: Email. Required.
76+
- `--admin`: If provided, this makes the user an admin. Optional.
77+
- `--access-token`: If provided, an access token will be created for the user. Optional. (default: false).
78+
- `--must-change-password`: If provided, the created user will be required to choose a newer password after
6779
the initial login. Optional. (default: true).
68-
- ``--random-password``: If provided, a randomly generated password will be used as the password of
80+
- ``--random-password``: If provided, a randomly generated password will be used as the password of
6981
the created user. The value of `--password` will be discarded. Optional.
70-
- `--random-password-length`: If provided, it will be used to configure the length of the randomly
82+
- `--random-password-length`: If provided, it will be used to configure the length of the randomly
7183
generated password. Optional. (default: 12)
72-
- Examples:
73-
- `gitea admin create-user --username myname --password asecurepassword --email me@example.com`
74-
- `change-password`
75-
- Options:
76-
- `--username value`, `-u value`: Username. Required.
77-
- `--password value`, `-p value`: New password. Required.
78-
- Examples:
79-
- `gitea admin change-password --username myname --password asecurepassword`
84+
- Examples:
85+
- `gitea admin create-user --username myname --password asecurepassword --email me@example.com`
86+
- `change-password`:
87+
- Options:
88+
- `--username value`, `-u value`: Username. Required.
89+
- `--password value`, `-p value`: New password. Required.
90+
- Examples:
91+
- `gitea admin change-password --username myname --password asecurepassword`
8092
- `regenerate`
8193
- Options:
8294
- `hooks`: Regenerate git-hooks for all repositories

0 commit comments

Comments
 (0)