diff --git a/commands.md b/commands.md index 81cdd32..43fa101 100644 --- a/commands.md +++ b/commands.md @@ -2,12 +2,14 @@ Vanguard has several commands that are designed to be run, however most commands for Vanguard are for internal use and for the scheduler. Below are commands that **can** be manually ran: -| Command | Full Command | Description | Usage Notes | -|----------------------------------------|-----------------------------------------------------|--------------------------------------------------------|--------------------------------------------------------------------------------------------------| -| `vanguard:generate-ssh-key` | `php artisan vanguard:generate-ssh-key` | Generates an SSH key required for backup operations. | The generated keys will be stored in the `storage/app/ssh` directory. Keep the private key safe. | -| `vanguard:version` | `php artisan vanguard:version` | Displays the current version of Vanguard. | Use `--check` flag to check for newer versions on GitHub. | +| Command | Full Command | Description | Usage Notes | +|----------------------------------------|----------------------------------------------------|--------------------------------------------------------|--------------------------------------------------------------------------------------------------| +| `vanguard:generate-ssh-key` | `php artisan vanguard:generate-ssh-key` | Generates an SSH key required for backup operations. | The generated keys will be stored in the `storage/app/ssh` directory. Keep the private key safe. | +| `vanguard:version` | `php artisan vanguard:version` | Displays the current version of Vanguard. | Use `--check` flag to check for newer versions on GitHub. | | `vanguard:validate-s3-connection {id}` | `php artisan vanguard:validate-s3-connection {id}` | Validates the connection to an S3 backup destination. | Replace `{id}` with the primary key of the backup destination. | -| `vanguard:disable-two-factor {email}` | `php artisan vanguard:disable-two-factor {email}` | Disables two-factor authentication for the given user. | Replace `{email}` with the email address of the user you wish to disable two-factor for. | +| `vanguard:disable-two-factor {email}` | `php artisan vanguard:disable-two-factor {email}` | Disables two-factor authentication for the given user. | Replace `{email}` with the email address of the user you wish to disable two-factor for. | +| `vanguard:disable-user-account {id}` | `php artisan vanguard:disable-user-account {id}` | Disables the user account, they cannot login. | Replace `{id}` with the id of the user you wish to disable. Admins cannot be disabled. | + ::: info Note The `vanguard:generate-ssh-key` command can only be run once. You will not be allowed to generate another SSH key if one is already configured.