Skip to content

CLI Commands

Sleeps edited this page Jul 2, 2026 · 1 revision

Most of what you can do on the website you can do via CLI commands.

This is ripped from the README and needs an update but currently:

Web accounts:

php artisan vw:users

Add a new user:

php artisan vw:users add

Delete a user:

php artisan vw:users delete 1
php artisan vw:users delete john@example.com

Search users:

php artisan vw:users search john
php artisan vw:users search "john doe"
php artisan vw:users search john --role=system_admin
php artisan vw:users search john --status=active

List all users:

php artisan vw:users list
php artisan vw:users list --role=system_admin
php artisan vw:users list --status=active

Show user details:

php artisan vw:users show 1
php artisan vw:users show john@example.com

Activate a user:

php artisan vw:users activate 1
php artisan vw:users activate john@example.com

Deactivate a user:

php artisan vw:users deactivate 1
php artisan vw:users deactivate john@example.com

Email accounts

php artisan vw:email

Add a new email user:

php artisan vw:email add

Delete an email user:

php artisan vw:email delete user@example.com
php artisan vw:email delete 1

Search email users:

php artisan vw:email search user@example.com
php artisan vw:email search user --domain=example.com

List email users:

php artisan vw:email list
php artisan vw:email list --domain=example.com
php artisan vw:email list --type=local
php artisan vw:email list --status=enabled

Show email user details:

php artisan vw:email show user@example.com
php artisan vw:email show 1

Enable an email user:

php artisan vw:email enable user@example.com

Disable an email user:

php artisan vw:email disable user@example.com

Domain management

php artisan vw:domains

Add a new domain:

php artisan vw:domains add

Delete a domain:

php artisan vw:domains delete 1
php artisan vw:domains delete example.com

Search domains:

php artisan vw:domains search example
php artisan vw:domains search example --type=local
php artisan vw:domains search example --status=enabled

List all domains:

php artisan vw:domains list
php artisan vw:domains list --type=local
php artisan vw:domains list --status=enabled

Show domain details:

php artisan vw:domains show 1
php artisan vw:domains show example.com

Activate a domain:

php artisan vw:domains activate 1
php artisan vw:domains activate example.com

Deactivate a domain:

php artisan vw:domains deactivate 1
php artisan vw:domains deactivate example.com

** Assign a user to a domain:**

php artisan vw:domains assign 1 --user=5 --role=domain_admin
php artisan vw:domains assign example.com --user=john@example.com --role=viewer

Unassign a user from a domain:

php artisan vw:domains unassign 1 --user=5
php artisan vw:domains unassign example.com --user=john@example.com

Clone this wiki locally