User

---

List

List all users.

$ wireshell user:list

Available options:

--role : filter by user role (given the role exists)

Examples

List all users.

$ wireshell user:list

Users: 2

 ========== =========== =========== ==================
  Username   E-Mail      Superuser   Roles
 ========== =========== =========== ==================
  admin      pw@ws.com   ✔           guest, superuser
  guest                              guest
 ========== =========== =========== ==================

List all superusers.

$ wireshell user:list --role=superuser

Users: 1

 ========== =========== =========== ==================
  Username   E-Mail      Superuser   Roles
 ========== =========== =========== ==================
  admin      pw@ws.com   ✔           guest, superuser
 ========== =========== =========== ==================

---

Create

Create an user.

$ wireshell user:create {user-name}

Available options:

--email : mail address for the user 
--password : password for the user
--roles : assign user roles, comma separated (given the role exist), role `guest` is attached by default

Examples

Create a new user by given email, password and role.

$ wireshell user:create editor --email="editor@ws.pw" --password=cgBG+T9e7Nu2 --roles=editor

Create a new user with role guest.

$ wireshell user:create pwguest --email="guest@ws.pw" --password=ws6jem6un3V&

Create a new user with roles superuser and editor.

$ wireshell user:create pwadmin --roles=superuser,editor

Please enter a email address : pwadmin@ws.pw
Please enter a password :

---

Delete

Delete an user or multiple users at once (by name or role).

$ wireshell user:delete {user-name},{user-name}*

* This argument is optional. If you want to delete users by role instead, just skip it.

Available options:

--role : role name

Examples

Delete an user.

$ wireshell user:delete pweditor

Delete multiple users.

$ wireshell user:delete pwadmin,pwguest

Delete users by given role.

$ wireshell user:delete --role=editor

---

Update

Update an existing user.

$ wireshell user:update {user-name}

Available options:

--email : mail address for the user 
--password : password for the user
--roles : assign user roles, comma separated (given the role exist), role `guest` is attached by default

Examples

Update an user; sets new email address.

$ wireshell user:update pweditor --email=otto@example.org

Update an user; sets new email, password and roles.

$ wireshell user:update pwguest --email=otto@example.org --roles=superuser,editor --password=somepass