Laravel Code Generator

Command

php artisan create:views-layout [application-name]

Or

php artisan create:layout [application-name]

Example

php artisan create:layout "My New Laravel App"

The name of your application

Default: app

The name of the layout file to be used.

In this example the layout file will be "app.blade.php"

Default: layouts

The directory to create the layout under.

This option allows you to use a different template at run time.

If this option is left out, the default template is used.

Note: the default template can be set from the config file i.e config/codegenerator.php by setting the template key.

This option allows you to create a layout without any client-side validation

Note: client-side validation will boost your app performance.

This option will override the layout if one already exists.

Command

php artisan create:resources [model-name]

Example

php artisan create:resources Post

The model name to create resources for.

Default: the plural-form of the model name. If the model name is AssetCategory, the name will then be asset_categories.json

The name of the file to import fields from. This option allows you have all fields in one json file, and then import it from the command line. This is a powerful feature which makes it easy to configure the fields, then reuse the same fields in multiple command now or in the future. More documentation on how to manage fields-file can be found in the "Managing fields using JSON file" section.

Fields to use for creating the validation rules. More documentation about this option can be found in the "assign model fields from JSON file" section below.

The name of the controller to create. If the provided value does not end with the word "Controller" it will be appended.

If this option is left out, the controller's name will be generated using the plural-form of the giving model's name.

In the above example, the controller will be called "PostsController".

Default: Http\Controllers\Controller

Here you can specify which class should the controller extends. By default, we extend Http\Controllers\Controller.

You may pass the value no_value to not extend any class.

When used, this option will add the auth:api to the controller. It will prevent any un-authenticated users to access the resources.

In order to use this option, you must enable Laravel's built in authentication.

Prefix of the route group.

For example, if the word "frontend" was provided, it assumes that all the generated routes start with /frontend/.

Default = 25

The amount of models to show per page on the index view. By default, the "Index" method will display 25 records per page.

Instead of placing the field's validation rules directly in the controller class, this option will extract the rules into a separate form-request class. The form-request class allows you to do more complex validation, cleans up your controller, and increases your code reusability.

The database's table name.

If this option is left out, it is assumed that the table name is the plural-form of the model-name.

In the above example, the table name will be "posts".

If the model name is AssetCategory, the table name will be "asset_categories".

This option allows you to generate resources from existing database table.

When this option is used, the database's name is assumes to be the plural-form of the provided "model-name". Of course, the table name can be set to a different value by passing the --table-name option.

A comma separated languages.

When creating resources from existing database using the --table-exists options, --transation-for allows you to create multi-language labels. You still have to provide translation for the corresponding language.

If this option is left out, no translation key's will be generated.

For example, --translation-for=en,ar,fr this option will create label under the following languages en, ar and fr

The languages file name to put the labels "if any" in.

If one isn't provided, the file name will be the plural-form of the provided model name.

A comma separated string to put in the fillable property of the model. For example 'title','description'

You may also set the fillable fields from the fields property directly. When this option is left out, any field that is flagged is-on-form will automatically be added to the fillable list.

A string to define the relationships to other models. This option allows you to create relationship between different models. For example, to build a has-many relation between "Post" model and "Comment" model the following string is used "comments#hasMany#App\Models\Comment|id|post_id"

Here is a description of the string read from left to right using the # as a separator

comments the relationship name "aka the method name"

hasMany the type of relation.

App\Models\Comment first parameter to pass to hasMay method.

Id second parameter to pass to hasMay method.

post_id third parameter to pass to hasMay method.

For more info about the available relations and the required parameters, visit Laravel documentation

Default = id

The field's name of the primary key. The default value can be overridden by setting the is-auto-increment or the is-primary flag to true in the fields setup.

Enables the soft-delete feature that eloquent provides.

Prevent Eloquent from maintaining both created_at and the updated_at properties.

A list of index can be provide here. You may wish to create composite index. Additionally, you can set the single field to be an indexes from the fields setup. This can be done by setting the is-index, is-unique, or is-primary properties of a field.

Here is an example, --index='update_at','name'#unique='some_unique_column'#unique=col1_name,col2_name

You can provide a list of foreign keys to add.

Here is an example, --foreign-keys=user_id|id|users|cascade|cascade#deleted_by|id|users

This example will generate the following code

$table->foreign('user_id')
	  ->references('id')
	  ->on('users')
	  ->onDelete('cascade')
	  ->onUpdate ('cascade');

$table->foreign('deleted_by')
	  ->references('id')
	  ->on('users');

When using a database first approach, migrations are not necessary. Providing this option will prevent the resources command from creating a migration file.

The name of the migration class.

If this option is not set, a name will be generated based on the model name.

Eloquent uses the configured default database connection. Providing a value here will tell Eloquent to connect using the provided connection.

A specific engine name for the database's table can be provided here.

The directory where the controller should be created under.

For example, if the word "Frontend" was provided, the controller will be created in App/Http/Controllers/Frontend directory.

A directory where the model will be created under.

The name of the directory to create the views under.

If this option is left out, the views will be created in /resources/views

This option allows you to use a different template at run time.

If this option is left out, the default template is used.

Note: the default template can be set from the config file i.e config/codegenerator.php by setting the template key.

This option will override any existing files if any exists.

Command

php artisan create:mapped-resources

Example

php artisan create:mapped-resources

Default: Http\Controllers\Controller

Here you can specify which class should the controller extends. by default, we extend Http\Controllers\Controller.

You may pass the value no_value to not extend any class.

When used, this option will add the auth:api to the controller. It will prevent any un-authenticated uses can access the resources.

In order to use this option, you must enable Laravel's built in authentication.

Default = 25

The amount of models to show per page on the index view. By default, the "Index" method will display 25 records per page.

Instead of placing the field's validation rules directly in the controller class, this option will extract the rules into a separate form-request class. The form-request class allows you to do more complex validation, cleans up your controller, and increases your code reusability.

The directory where the form-request should be created under.

For example, if the word "Frontend" was provided, the form-request will be created in App/Http/Requests/Frontend directory.

This option allows you to generate resources from existing database table.

When this option is used, the database's name is assumes to be the plural-form of the provided "model-name". Of course, the table name can be set to a different value by passing the --table-name option.

A comma separated languages.

When creating resources from existing database using the --table-exists options, --transation-for allows you to create multi-language labels. You still have to provide translation for the corresponding language.

If this option is left out, no translation key's will be generated.

For example, --translation-for=en,ar,fr this option will create label under the following languages en, ar and fr

The languages file name to put the labels "if any" in.

If one isn't provided, the file name will be the plural-form of the provided model name.

Default = id

The field's name of the primary key. The default value can be overridden by setting the is-auto-increment or the is-primary flag to true in the fields setup.

Enables the soft-delete feature that eloquent provides.

Prevent Eloquent from maintaining both created_at and the updated_at properties.

When using a database first approach, migrations are not necessary. Providing this option will prevent the resources command from creating a migration file.

Eloquent uses the configured default database connection. Providing a value here will tell Eloquent to connect using the provided connection.

A specific engine name for the database's table can be provided here.

The directory where the controller should be created under.

For example, if the word "Frontend" was provided, the controller will be created in App/Http/Controllers/Frontend directory.

A directory where the model will be created under.

The name of the directory to create the views under.

If this option is left out, the views will be created in /resources/views

This option allows you to use a different template at run time.

If this option is left out, the default template is used.

Note: the default template can be set from the config file i.e config/codegenerator.php by setting the template key.

This option will override existing files if any exists.

This option allows you to pass the name of the mapping file. When this option is left out, the default resources_map file will be used.

Command

php artisan create:controller [model-name]

Example

php artisan create:controller Posts

The model name to create the controller for.

The name of the controller to create. If the provided value does not end with the word "Controller" it will be appended.

If this option is left out, the controller name is generated from the provided model name.

In the example above, the controller name will be "PostsController".

Default: the plural-form of the model name. If the model name is AssetCategory, the name will then be asset_categories.json

The name of the file to import fields from. This option allows you have all fields in one json file, and then import it from the command line. This is a powerful feature which makes it easy to configure the fields, then reuse the same fields in multiple command now or in the future. More documentation on how to manage fields-file can be found in the "Managing fields using JSON file" section.

Fields to use for creating the validation rules. More documentation about this option can be found in the "assign model fields from JSON file" section below.

Prefix of the route group.

For example, if the word "frontend" was provided, it assumes that all the generated routes start with /frontend/.

Default = 25

The amount of models to show per page on the index view. By default, the "Index" method will display 25 records per page.

The languages file name to put the labels "if any" in.

If one isn't provided, the file name will be the plural-form of the provided model name.

Default: Http\Controllers\Controller

Here you can specify which class should the controller extends. by default, we extend Http\Controllers\Controller.

You may pass the value no_value to not extend any class.

When used, this option will add the auth:api to the controller. It will prevent any un-authenticated uses can access the resources.

In order to use this option, you must enable Laravel's built in authentication.

Instead of placing the field's validation rules directly in the controller class, this option will extract the rules into a separate form-request class. The form-request class allows you to do more complex validation, cleans up your controller, and increases your code reusability.

The directory where the form-request should be created under.

For example, if the word "Frontend" was provided, the form-request will be created in App/Http/Requests/Frontend directory.

The directory where the controller should be created under.

For example, if the word "Frontend" was provided, the controller will be created in App/Http/Controllers/Frontend directory.

A directory where the model will be created under.

The name of the directory to create the views under.

If this option is left out, the views will be created in /resources/views

This option allows you to use a different template at run time.

If this option is left out, the default template is used.

Note: the default template can be set from the config file i.e config/codegenerator.php by setting the template key.

This option will override the controller if one already exists.

Command

php artisan create:model [model-name]

Example

php artisan create:model Post

The name of the model.

Default: the plural-form of the model name. If the model name is AssetCategory, the name will then be asset_categories.json

The name of the file to import fields from. This option allows you have all fields in one json file, and then import it from the command line. This is a powerful feature which makes it easy to configure the fields, then reuse the same fields in multiple command now or in the future. More documentation on how to manage fields-file can be found in the "Managing fields using JSON file" section.

Fields to use for creating the validation rules. More documentation about this option can be found in the "assign model fields from JSON file" section below.

The database's table name.

If this option is left out, it is assumed that the table name is the plural-form of the model-name.

In the above example, the table name will be "posts".

If the model name is AssetCategory, the table name will be "asset_categories".

A comma separated string to put in the fillable property of the model. For example 'title','description'

You may also set the fillable fields from the fields property directly. When this option is left out, any field that is flagged is-on-form will automatically be added to the fillable list.

A directory where the model will be created under.

A string to define the relationships to other models. This option allows you to create relationship between different models. For example, to build a has-many relation between "Post" model and "Comment" model the following string is used "comments#hasMany#App\Models\Comment|id|post_id"

Here is a description of the string read from left to right using the # as a separator

comments the relationship name "aka the method name"

hasMany the type of relation.

App\Models\Comment first parameter to pass to hasMay method.

Id second parameter to pass to hasMay method.

post_id third parameter to pass to hasMay method.

For more info about the available relations and the required parameters, visit Laravel documentation

Default = id

The field's name of the primary key. The default value can be overridden by setting the is-auto-increment or the is-primary flag to true in the fields setup.

Enables the soft-delete feature that eloquent provides.

Prevent Eloquent from maintaining both created_at and the updated_at properties.

This option allows you to use a different template at run time.

If this option is left out, the default template is used.

Note: the default template can be set from the config file i.e config/codegenerator.php by setting the template key.

This option will override the model if one already exists.

Command

php artisan create:routes [model-name]

Example

php artisan create:routes Post

The model name that the routes will represent.

The name of the controller that these routes point to. If the provided value does not end with the word "Controller" it will be appended.

If this option is left out, the controller's name will be generated using the plural-form of the giving model's name.

In the above example, the controller will be called "PostsController".

Prefix of the route group.

For example, if the word "frontend" was provided, it assumes that all the generated routes start with /frontend/.

This option allows you to use a different template at run time.

If this option is left out, the default template is used.

Note: the default template can be set from the config file i.e config/codegenerator.php by setting the template key.

Command

php artisan create:views [model-name]

Example

php artisan create:views Post

The model name that the created views will represent.

Default: the plural-form of the model name. If the model name is AssetCategory, the name will then be asset_categories.json

The name of the file to import fields from. This option allows you have all fields in one json file, and then import it from the command line. This is a powerful feature which makes it easy to configure the fields, then reuse the same fields in multiple command now or in the future. More documentation on how to manage fields-file can be found in the "Managing fields using JSON file" section.

Fields to use for creating the validation rules. More documentation about this option can be found in the "assign model fields from JSON file" section below.

Prefix of the route group.

For example, if the word "frontend" was provided, it assumes that all the generated routes start with /frontend/.

Default = create,edit,index,show,form

The only views to be created. A comma separated string with the name of the views to create.

Default = layouts.app

A different layout could be used to generate the views. This can easily be done by providing a different layout name.

For example, if the physical path to a different layout was /resources/views/layouts/template/newlayout.blade.php then its name would be layouts.template.newlayout

This option allows you to use a different template at run time.

If this option is left out, the default template is used.

Note: the default template can be set from the config file i.e config/codegenerator.php by setting the template key.

The name of the directory to create the views under.

If this option is left out, the views will be created in /resources/views

This option will override any views if any already exists.

Command

php artisan create:create-view [model-name]

Example

php artisan create:create-view Post

The model name that this view will represent.

Default: the plural-form of the model name. If the model name is AssetCategory, the name will then be asset_categories.json

The name of the file to import fields from. This option allows you have all fields in one json file, and then import it from the command line. This is a powerful feature which makes it easy to configure the fields, then reuse the same fields in multiple command now or in the future. More documentation on how to manage fields-file can be found in the "Managing fields using JSON file" section.

Fields to use for creating the validation rules. More documentation about this option can be found in the "assign model fields from JSON file" section below.

Prefix of the route group.

For example, if the word "frontend" was provided, it assumes that all the generated routes start with /frontend/.

Default = layouts.app

A different layout could be used to generate the views. This can easily be done by providing a different layout name.

For example, if the physical path to a different layout was /resources/views/layouts/template/newlayout.blade.php then its name would be layouts.template.newlayout

This option allows you to use a different template at run time.

If this option is left out, the default template is used.

Note: the default template can be set from the config file i.e config/codegenerator.php by setting the template key.

The name of the directory to create the views under.

If this option is left out, the views will be created in /resources/views

This option will override the view if one already exists.

Command

php artisan create:edit-view [model-name]

Example

php artisan create:edit-view Post

The model name that this view will represent.

Default: the plural-form of the model name. If the model name is AssetCategory, the name will then be asset_categories.json

The name of the file to import fields from. This option allows you have all fields in one json file, and then import it from the command line. This is a powerful feature which makes it easy to configure the fields, then reuse the same fields in multiple command now or in the future. More documentation on how to manage fields-file can be found in the "Managing fields using JSON file" section.

Fields to use for creating the validation rules. More documentation about this option can be found in the "assign model fields from JSON file" section below.

Prefix of the route group.

For example, if the word "frontend" was provided, it assumes that all the generated routes start with /frontend/.

Default = layouts.app

A different layout could be used to generate the views. This can easily be done by providing a different layout name.

For example, if the physical path to a different layout was /resources/views/layouts/template/newlayout.blade.php then its name would be layouts.template.newlayout

This option allows you to use a different template at run time.

If this option is left out, the default template is used.

Note: the default template can be set from the config file i.e config/codegenerator.php by setting the template key.

The name of the directory to create the views under.

If this option is left out, the views will be created in /resources/views

This option will override the view if one already exists.

Command

php artisan create:index-view [model-name]

Example

php artisan create:index-view Post

The model name that this view will represent.

Default: the plural-form of the model name. If the model name is AssetCategory, the name will then be asset_categories.json

The name of the file to import fields from. This option allows you have all fields in one json file, and then import it from the command line. This is a powerful feature which makes it easy to configure the fields, then reuse the same fields in multiple command now or in the future. More documentation on how to manage fields-file can be found in the "Managing fields using JSON file" section.

Fields to use for creating the validation rules. More documentation about this option can be found in the "assign model fields from JSON file" section below.

Prefix of the route group.

For example, if the word "frontend" was provided, it assumes that all the generated routes start with /frontend/.

Default = layouts.app

A different layout could be used to generate the views. This can easily be done by providing a different layout name.

For example, if the physical path to a different layout was /resources/views/layouts/template/newlayout.blade.php then its name would be layouts.template.newlayout

This option allows you to use a different template at run time.

If this option is left out, the default template is used.

Note: the default template can be set from the config file i.e config/codegenerator.php by setting the template key.

The name of the directory to create the views under.

If this option is left out, the views will be created in /resources/views

This option will override the view if one already exists.

Command

php artisan create:show-view [model-name]

Example

php artisan create:show-view Post

The model name that this view will represent.

Default: the plural-form of the model name. If the model name is AssetCategory, the name will then be asset_categories.json

The name of the file to import fields from. This option allows you have all fields in one json file, and then import it from the command line. This is a powerful feature which makes it easy to configure the fields, then reuse the same fields in multiple command now or in the future. More documentation on how to manage fields-file can be found in the "Managing fields using JSON file" section.

Fields to use for creating the validation rules. More documentation about this option can be found in the "assign model fields from JSON file" section below.

Prefix of the route group.

For example, if the word "frontend" was provided, it assumes that all the generated routes start with /frontend/.

Default = layouts.app

A different layout could be used to generate the views. This can easily be done by providing a different layout name.

For example, if the physical path to a different layout was /resources/views/layouts/template/newlayout.blade.php then its name would be layouts.template.newlayout

This option allows you to use a different template at run time.

If this option is left out, the default template is used.

Note: the default template can be set from the config file i.e config/codegenerator.php by setting the template key.

The name of the directory to create the views under.

If this option is left out, the views will be created in /resources/views

This option will override the view if one already exists.

Command

php artisan create:form-view [model-name]

Example

php artisan create:form-view Post

The model name that this view will represent.

Default: the plural-form of the model name. If the model name is AssetCategory, the name will then be asset_categories.json

The name of the file to import fields from. This option allows you have all fields in one json file, and then import it from the command line. This is a powerful feature which makes it easy to configure the fields, then reuse the same fields in multiple command now or in the future. More documentation on how to manage fields-file can be found in the "Managing fields using JSON file" section.

Fields to use for creating the validation rules. More documentation about this option can be found in the "assign model fields from JSON file" section below.

Prefix of the route group.

For example, if the word "frontend" was provided, it assumes that all the generated routes start with /frontend/.

Default = layouts.app

A different layout could be used to generate the views. This can easily be done by providing a different layout name.

For example, if the physical path to a different layout was /resources/views/layouts/template/newlayout.blade.php then its name would be layouts.template.newlayout

This option allows you to use a different template at run time.

If this option is left out, the default template is used.

Note: the default template can be set from the config file i.e config/codegenerator.php by setting the template key.

The name of the directory to create the views under.

If this option is left out, the views will be created in /resources/views

This option will override the view if one already exists.

Command

php artisan create:migration [model-name]

Example

php artisan create:migration Post

The name of the model.

The database's table name.

If this option is left out, it is assumed that the table name is the plural-form of the model-name.

In the above example, the table name will be "posts".

If the model name is AssetCategory, the table name will be "asset_categories".

Default: the plural-form of the model name. If the model name is AssetCategory, the name will then be asset_categories.json

The name of the file to import fields from. This option allows you have all fields in one json file, and then import it from the command line. This is a powerful feature which makes it easy to configure the fields, then reuse the same fields in multiple command now or in the future. More documentation on how to manage fields-file can be found in the "Managing fields using JSON file" section.

Fields to use for creating the validation rules. More documentation about this option can be found in the "assign model fields from JSON file" section below.

The name of the migration class.

If this option is not set, a name will be generated based on the table name.

Enables the soft-delete feature that eloquent provides.

Eloquent uses the configured default database connection. Providing a value here will tell Eloquent to connect using the provided connection.

You can provide a list of indexes here. However, you can also set the single column indexes from the fields. This can be done by setting the is-index, is-unique, or is-primary properties of a field.

Here is an example, --index='update_at','name'#unique='some_unique_column'#unique=col1_name,col2_name

You can provide a list of foreign keys to add.

Here is an example, --foreign-keys=user_id|id|users|cascade|cascade#deleted_by|id|users

This example will generate the following code

$table->foreign('user_id')
	  ->references('id')
	  ->on('users')
	  ->onDelete('cascade')
	  ->onUpdate ('cascade');

$table->foreign('deleted_by')
	  ->references('id')
	  ->on('users');

A specific engine name for the database's table can be provided here.

Prevent Eloquent from maintaining both created_at and the updated_at properties.

This option allows you to use a different template at run time.

If this option is left out, the default template is used.

Note: the default template can be set from the config file i.e config/codegenerator.php by setting the template key.

This option will override the migration if one already exists.

Command

php artisan create:form-request [model-name]

Example

php artisan create:form-request Post

The name of the model.

The name of the form-request class.

Default: the plural-form of the model name. If the model name is AssetCategory, the name will then be asset_categories.json

The name of the file to import fields from. This option allows you have all fields in one json file, and then import it from the command line. This is a powerful feature which makes it easy to configure the fields, then reuse the same fields in multiple command now or in the future. More documentation on how to manage fields-file can be found in the "Managing fields using JSON file" section.

Fields to use for creating the validation rules. More documentation about this option can be found in the "assign model fields from JSON file" section below.

When used, this option will add the auth:api to the controller. It will prevent any un-authenticated users to access the resources.

In order to use this option, you must enable Laravel's built in authentication.

This option allows you to use a different template at run time.

If this option is left out, the default template is used.

Note: the default template can be set from the config file i.e config/codegenerator.php by setting the template key.

The directory where the form-request should be created under.

For example, if the word "Frontend" was provided, the form-request will be created in App/Http/Requests/Frontend directory.

This option will override the form-request if one already exists.

Command

php artisan create:language [model-name]

Example

php artisan create:language Post

The name of the model that these fields will represent.

The language file name to store the keys under. Typically, this would be the plural-form of the model name.

Default: the plural-form of the model name. If the model name is AssetCategory, the name will then be asset_categories.json

The name of the file to import fields from. This option allows you have all fields in one json file, and then import it from the command line. This is a powerful feature which makes it easy to configure the fields, then reuse the same fields in multiple command now or in the future. More documentation on how to manage fields-file can be found in the "Managing fields using JSON file" section.

Fields to use for creating the validation rules. More documentation about this option can be found in the "assign model fields from JSON file" section below.

This option allows you to use a different template at run time.

If this option is left out, the default template is used.

Note: the default template can be set from the config file i.e config/codegenerator.php by setting the template key.

Command

php artisan fields-file:create [model-name]

Example

php artisan fields-file:create Post

The name of the model that these fields will represent.

The name of the file to be created. When this option is left out, the file will be the plural-form of the model name.

If the model name is AssetCategory, the file name will be asset_categories.json.

A list of the field names to be created. The names should be separated by a comma.

A list of the data type to be created. The types should be separated by a comma.

A list of the html type to be created. The types should be separated by a comma.

By default, this command will add primary key field called id to the resource. This option can be used to create the fields file without a primary key

A comma separated languages.

When creating a multi-language application, this option allows for creating translation key in multiple languages. You still have to provide translation for the corresponding language.

If this option is left out, no translation key's will be generated.

For example, --translation-for=en,ar,fr this option will create label under the following languages en, ar and fr

This option will override the field's file if one already exists.

Command

php artisan fields-file:append [model-name]

Example

php artisan fields-file:append Post

The name of the model that these fields will represent.

The name of the file to be created. When this option is left out, the file will be the plural-form of the model name.

A list of the field names to be added. The names should be separated by a comma.

A list of the data type to be created. The types should be separated by a comma.

A list of the html type to be created. The types should be separated by a comma.

A comma separated languages.

When creating a multi-language application, this option allows for creating translation key in multiple languages. You still have to provide translation for the corresponding language.

If this option is left out, no translation key's will be generated.

For example, --translation-for=en,ar,fr this option will create label under the following languages en, ar and fr

Command

php artisan fields-file:reduce [model-name]

Example

php artisan fields-file:reduce Post

The name of the model that these fields will represent.

The name of the file to be created. When this option is left out, the file will be the plural-form of the model name.

A list of the field names to be removed. The names should be separated by a comma.

Command

php artisan fields-file:delete [model-name]

Example

php artisan fields-file:delete Post

The name of the model that these fields represents.

The name of the file to be created. When this option is left out, the file will be the plural-form of the model name.

Command

php artisan create:fields-file [table-name]

Example

php artisan create:fields-file posts

The name of the model that represents these fields.

The name of your existing database's table name.

When this option is left out, the table name is the plural-form of the model name.

If the model name is AssetCategory, the table name is assumed to be asset_categories

The database name to look under.

If this option is left out, the database name in the database connection is used.

Default: the plural-form of the model name. If the model name is AssetCategory, the name will then be asset_categories.json

The name of the file to import fields from. This option allows you have all fields in one json file, and then import it from the command line. This is a powerful feature which makes it easy to configure the fields, then reuse the same fields in multiple command now or in the future. More documentation on how to manage fields-file can be found in the "Managing fields using JSON file" section.

Fields to use for creating the validation rules. More documentation about this option can be found in the "assign model fields from JSON file" section below.

The name of the file to generate the fields in.

If this option is left out, the generate name file will be the same name as the database's table.

A comma separated languages.

When creating a multi-language application, this option allows for creating translation key in multiple languages. You still have to provide translation for the corresponding language.

If this option is left out, no translation key's will be generated.

For example, --translation-for=en,ar,fr this option will create label under the following languages en, ar and fr

This option will override the field's file if one already exists.

Required

A unique name for the field

A title to describe the field. If this option is left out, the field name is used to generate an English title.

You can pass any valid Laravel validation rule. The rules should be separated by bar |.

For example: required|string|min:2|max:255

To learn more about the valid options please visit Laravel documentation

Default: text

A valid property will be one of the following options

• text
• textarea
• password
• email
• checkbox
• radio
• number
• select
• hidden
• file
• selectRange
• selectMonth
• multipleSelect

Default: "; "

When generating a form with checkbox or a select menu that accepts multiple answers, we need either store the results in a foreign model or store the records in a string field. By default, the code generator will convert the multiple options that a user selected into a json string before the results are stored using a mutators method.

When the data is presented on the show and/or index views, the options are displayed separated by the value of the delimiter. Of course, you can always change this behavior to fit your needs by removing the accessor and mutator methods in the model and modifying the views.

Default: ""

You can add custom css class(es) to the html input. Any value is placed in this option will be added to the field's class="..." property.

Default: "m/d/Y H:i A"

Any field with the type date, time or datetime can be formatted different when it is displayed. You can change the display format using this option.

Default: null

A default value to set the field to.

When using multiple options based html-type like checkbox, multipleSelect you can set this property to array of values to set multiple values by default. Ex, ["Red","Green"]

Default = empty string If you used `select` for the `html-type` property, this is where you provide the options. Here are example of how to use it options=Male|Femle

Or if you want to have a different value that the title, you can pass the options like so options=1:Male|2:Female

However, when using --fields-file option to import json, you can define multiple language phrases for each option

"options": {
    "en": {
        "": "Prefer not to say",
        "1": "Male",
        "2": "Female"
    },
    "ar": {
        "": "Prefer not to say in Arabic",
        "1": "Male in Arabic",
        "2": "Female in Arabic"
    },
    "fr": {
        "": "Prefer not to say in French",
        "1": "Male in French",
        "2": "Female in French"
    }
}

Default = false

If the html-type is set to radio or checkbox, setting this option to true will put the items next to each other instead of a vertical list.

Default = empty string

You can set a placeholder value when html-type is set to text, number, email, textarea orselect.

Default = true

Setting the value to false will prevent from adding this field to the index view.

Default = true

Setting the value to false will prevent from adding this field to the form view.

Default = true

Setting the value to false will prevent from adding this field to the show view.

Default = true

Setting the value to false will prevent from adding this field to the index, form or show view. This is just a short way to change the visibility for all views.

Default = false

Only one field can be set to a header. The header field will be use as the page header in the show view.

The key common_header_patterns in the configuration file, allow you to list the commond field name to automaticly set them as header.

Default = varchar

The database column type. The following are valid types.

'char', 'date', 'datetime', 'datetimetz', 'biginteger', 'bigint', 'blob', 'binary', 'bool', 'boolean', 'decimal', 'double', 'enum', 'list', 'float', 'int', 'integer', 'ipaddress', 'json', 'jsonb', 'longtext', 'macaddress', 'mediuminteger', 'mediumint', 'mediumtext', 'morphs', 'string', 'varchar', 'nvarchar', 'text', 'time', 'timetz', 'tinyinteger', 'tinyint', 'timestamp', 'timestamptz', 'unsignedbiginteger', 'unsignedbigint', 'unsignedInteger', 'unsignedint', 'unsignedmediuminteger', 'unsignedmediumint', 'unsignedsmallinteger', 'unsignedsmallint', 'unsignedtinyinteger', 'uuid', 'uuid'

Note: you can add short cuts if needed to in the codegenerator.php config file. You can add new mapping to the eloquent_type_to_method array.

This option allows you to specify parameters for the data type. Please ensure you provide valid parameters otherwise unexpected behavior will occur. For example, varchar and char will only need a maximum of one integer parameter where double, decimal and float require two integer parameters.

Command line example with specifying a decimal precision and scale:

Command line example data-type-params=5,2

"data-type-params": [
    5,
    2
]

Default = null

The default value for the database column.

Default = false

Setting this value to true will make this column a primary with auto increment identity.

Default = false

You can set this field as the primary for retrieving records from the database. You can only set one column as the primary. If you set multiple fields are primary, the first one will be selected and the rest will be ignored.

Note: if you set the is-auto-increment field, this option will automatically get set. Ths only time this can be used is to create a primary field you don't wish for the database to auto assign it.

Default = false

Setting this value to true will add index to this column.

Default = false

Setting this value to true will add a unique index to this column.

Default = false

Setting this value to true will make this column nullable.

Note: when setting this option to true, the default value will be set to NULL unless you pass a different value to data-value

Default = false

Setting this value to true will make this column unsigned. This option should only be used with numeric types only.

This option will allow you to add meta description of the field in the database.

This option will allow you to casts a data filed to a Carbon object.

This option will allow you to cast a field to php's native type.

This option will allow you to create a foreign relation between the models.

{
    "name": "creator",    // the name of the relation
    "type": "belongsTo",  // the type of the relation
    "params": [           // the parameters for the used relation.
        "App\\User",
        "created_by"
    ],
    "field": "name"      // the name of the field on the foreign model to use as display value
}

This option will allow you to create a foreign relation between the models.

{
    "field": "user_id",                     // the field name.
    "references": "id",                     // the field to reference on the foreign model.
    "on": "users",                          // the foreign model begin referenced.
    "on-delete":"cascade",                  // the on-delete action.
    "on-update":"cascade",                  // the on-update actions.
    "references-model": "App\\Models\\User" // the namespace of the foreign model.
}

This option allows you to set a fixed value on the store action. For example, Illuminate\Support\Facades\Auth::Id(); will set the value to the current user id when the model is first created. Assuming you're using Laravel Authentication.

Similar to on-storeThis option allows you to set a fixed value on the update action.