SeviaFlow Get Started

DevTools: Installation

seviaflow/devtools adds development commands for checking an installation, discovering Eloquent models, and generating Resource files. It depends on seviaflow/core and Illuminate Console; it is normally installed as a development dependency and is not required to serve the production UI or API.

1. Install the package

composer require --dev seviaflow/devtools:^0.1@dev

Composer installs the package into the Laravel application. If you only need the manually documented Resources, you can stop here and use the commands directly.

2. Publish settings when you need to change them

php artisan vendor:publish --tag=seviaflow-devtools-config

This publishes config/seviaflow-devtools.php. Edit it when your models are outside app/Models, when you want to ignore certain models, or when generated Resource files should use a different path or namespace. You can keep the package defaults when none of those cases apply.

The convenience command php artisan seviaflow:install can publish the configuration and other available SeviaFlow package files for the packages installed in the app. See Commands before using its migration or overwrite options.

3. Check the installation

php artisan seviaflow:doctor
php artisan seviaflow:status
php artisan seviaflow:list
CommandWhat to look for
seviaflow:doctorDiagnostics for common installation or configuration problems.
seviaflow:statusWhich SeviaFlow modules and routes are active.
seviaflow:listThe Resources and key configuration currently visible to SeviaFlow.

4. Discover models before generating files

Start with php artisan seviaflow:discover --with-schema to see model and schema suggestions without writing files. Review Discovery & Generation before enabling generation. Generated code is a starting point; you still need to choose business fields, authorization rules, tenant scoping, and the Resources to register.

Configuration defaults

DevTools reads SEVIAFLOW_DEVTOOLS_ENABLED, model discovery paths/namespaces, ignored models, and generation paths/namespaces from config/seviaflow-devtools.php. See Configuration Reference for the defaults.