Skip to content

Latest commit

 

History

History
96 lines (60 loc) · 3.85 KB

commands.md

File metadata and controls

96 lines (60 loc) · 3.85 KB

CLI Commands

Myth:Auth provides a few command line tools to make managing users and groups easier.

Publish

php spark auth:publish

The publish command integrates module components into an existing CodeIgniter 4 project. When run, you will be prompted about each component (e.g. Migrations, Views, Models, etc.) if you would like to merge them into your project. Most components will run in-place via Composer or manual autoloading (see also Autoloading in the CodeIgniter User Guide) but if you need to change code that cannot be extended then publishing is the easiest way to do it. publish will take care of copying the file into place and updating namespaces accordingly.

Arguments

publish accepts no arguments.

Create User

php spark auth:create_user [username] [email]

The create_user command will add a new user record to the database. This command creates the new user with only the username and email fields propagated, so the user will be forced to create a password at first login attempt. create_user will prompt for missing fields but can also accept them directly making it easy to batch load users from a file, script, or data stream. Users are added through Myth\Auth\Models\UserModel and thus are subject to validation rules and casts.

Arguments

  • username: A valid username (alpha-numeric or spaces, minimum length 3)
  • email: A valid, unique email address

Create Group

php spark auth:create_group [name] [description]

The create_group command will add a new group record to the database. The name and description parameters will both be prompted for if missing. If the new group is successfully created this command will list all the groups from the database by calling list_groups.

Arguments

  • name: A valid, unique group name (maximum length 255)
  • description: (optional) A valid description (maximum length 255)

List Groups

php spark auth:list_groups

The list_groups command displays all the groups in the database in a neatly ordered table.

Arguments

list_groups accepts no arguments.

Set Password

php spark auth:set_password [identity] [password]

The set_password command will set a new password for provided identity argument. The identity and password arguments will both be prompted for if missing. If identity value is passed by the user does not exist, you will get an error message: User with identity: {identity} not found. If the operation succeeds, you will get success message: Password successfully set for user with identity: {identity}. If the operation fails, you will get an error message: Failed to set password for user with identity: {identity}.

Arguments

The set_password command accepts two required arguments:

  • identity: A valid identity (username or email)
  • password: A valid password (minimum length according to the $minimumPasswordLength variable from auth config file)

Activate User

php spark auth:activate_user [identity]

The activate_user command will activate the existing user for provided identity. The identity argument will be prompted for if missing. If identity value passed by the user does not exist, you will get an error message: User with identity: {identity} not found. If the operation succeeds, you will get success message: Sucessfuly activated the user with identity: {identity}. If the operation fails, you will get an error message: Failed to activate the user with identity: {identity}.

Arguments

  • identity: A valid identity (username or email)

Hash Password

php spark auth:hash_password [password]

The hash_password command hashes the given password by the user and print it to the console as green colored text. The password argument will be prompted for if missing.

Arguments

  • password: A valid password