Manage Options

Options can be set or unset using Artisan commands or using the Administration.

Note

When used with modules, the group represents the module identifier.

List All Options

To view all registered options, run the command:

php artisan options:list {groups?*}

• {groups?*} – optional: specify one or more groups to filter the list. If omitted, all options from all groups will be displayed.

 ┌──────────────────────┬────────────────────────┬───────┬───────────┬─────────┐
 │ Group                │ Key                    │ Value │ Default   │ Type    │
 ├──────────────────────┼────────────────────────┼───────┼───────────┼─────────┤
 │ core::administration │ enable-modules-manager │ null  │ true      │ boolean │
 │ core::administration │ brand-name             │ null  │ "Laravel" │ string  │
 │ core::administration │ spa                    │ null  │ false     │ boolean │
 │ core::administration │ top-navigation         │ null  │ true      │ boolean │
 └──────────────────────┴────────────────────────┴───────┴───────────┴─────────┘

Set a Specific Option

To set an option, run:

Tip

You can omit arguments to use the interactive prompt.

php artisan options:set {group} {key} {value}

 ┌ Which group do you want to update? ────────────────────────┐
 │ core::administration                                       │
 └────────────────────────────────────────────────────────────┘

 ┌ Which key do you want to modify? ──────────────────────────┐
 │ spa                                                        │
 └────────────────────────────────────────────────────────────┘

 ┌ Enter the new value for the selected key: ─────────────────┐
 │                                                            │
 └────────────────────────────────────────────────────────────┘

Unset a Specific Option

Note

When an option is unset, the system will revert to the default value provided by the definition.

To unset an option:

Tip

You can omit arguments to use the interactive prompt.

php artisan options:unset {group} {keys*}

 ┌ Which group do you want to update? ────────────────────────┐
 │ core::administration                                       │
 └────────────────────────────────────────────────────────────┘

 ┌ Select the key(s) to unset ────────────────────────────────┐
 │   ◼ enable-modules-manager                                 │
 │ › ◼ brand-name                                             │
 │   ◻ spa                                                    │
 │   ◻ top-navigation                                         │
 └────────────────────────────────────────────────────────────┘