boaideas/laravel-cli-create-user

An artisan command to create, list and remove users in a laravel application from the cli

Easily create, list and remove Laravel users with a CLI command

, _(*1)

Using this artisan command it's easy to create Laravel users from the CLI whenever you need them. If you want, it will even email the user their credentials., _(*2)

The command will validate the user details using Laravel's regular validation engine (which means you can create your own rules). If you want, the command can create a random password for you., _(*3)

We also added commands to list all existing users and to easily remove users., _(*4)

Requirements

The package is based on the defaul User model that ships with Laravel, so it assumes you're using a model (you can name it anything you want) with name, email and password fields., _(*5)

Installation

You can install the package via composer:, _(*6)

composer require boaideas/laravel-cli-create-user

If you're installing the package on Laravel 5.5 or higher, you're done (The package uses Laravel's auto package discovery)., _(*7)

If you're using Laravel 5.4 or less, add the BOAIdeas\CreateUser\CreateUserServiceProvider service provider to your providers array:, _(*8)

// config/app.php

'providers' => [
    ...
    BOAIdeas\CreateUser\CreateUserServiceProvider::class,
];

Usage

Create a new user

From your CLI execute:, _(*9)

php artisan user:create

You will be asked for the user's name, email and password, and then the user account will be created. If you choose, a random password will be created for you., _(*10)

Input validation

Your input will be validated using Laravel's validation engine with Laravel's default user input rules (you can change the rules if you want)., _(*11)

Email user credentials

You will be asked if you want to send an email to the newly created user with their credentials. If you do, the command will send a regular Laravel notification to the user's email, so make sure you've sert your app's mail settings., _(*12)

The notification is using the default APP_NAME, APP_URL, MAIL_FROM_ADDRESS and MAIL_FROM_NAME so make sure they're set correctly., _(*13)

List all existing users

From your CLI execute:, _(*14)

php artisan user:list

You will be presented with a table of all existing users., _(*15)

Remove a user (by ID)

From your CLI execute:, _(*16)

php artisan user:remove {user_id}

The command will confirm that you want to remove that user and will remove it., _(*17)

Configuration

By default, the package assumes your User model is called User and validates your model input with the default rules that Laravel uses for users creation., _(*18)

If you want to change any of these settings, you can publish the config file with:, _(*19)

php artisan vendor:publish --provider="BOAIdeas\CreateUser\CreateUserServiceProvider"

This is the content of the published config file:, _(*20)

// config/createuser.php

return [
    /*
    * The class name of the user model to be used.
    */
    'model' => 'App\User',

    /*
    * The validation rules to check for user model input.
    */
    'validation_rules' => [
        'name' => 'string|max:255',
        'email' => 'string|email|max:255|unique:users',
        'password' => 'string|min:6',
    ],

];

Credits

• Amos Shacham
• All Contributors

Alternatives

• laravel-make-user
• laravel-cli-user
• create-user-command

License

The MIT License (MIT). Please see License File for more information., _(*21)