Advanced installation

Database

The installation asks — SQLite, PostgreSQL or MySQL. The default is SQLite, so it depends on nothing.

PostgreSQL is the recommended one, for a functional reason: it is the only one shipping pgvector, which the local AI features that use semantic search (embeddings) depend on. With SQLite or MySQL the rest of the kit runs the same — only those features are unavailable.

If you pick Postgres during installation, the .env already comes with the block docker-compose.yml reads. If the container is not up at that moment, the kit warns you, skips the migrations and prints the command to finish:

docker compose up -d
php artisan migrate --seed

To switch after the installation, bring the containers up and copy the variables:

docker compose up -d              # pgsql (with pgvector) + redis
# copy the database block from .env.docker into your .env
php artisan migrate --seed

Commands

composer dev          # server + queue + vite together
composer test         # pint + phpstan + filacheck + the whole suite
composer test:kit     # only the kit's tests (the foundation), in parallel
composer lint         # formats the code
composer lint:check   # only checks the formatting, changing nothing (what CI runs)
composer filament:check   # only the Filament-specific lint (FilaCheck)
composer refactor:preview # what Rector would rewrite (dry-run) — OUTSIDE composer test
composer refactor:apply   # applies Rector's rewrite — OUTSIDE composer test
composer upgrade:filament # runs vendor/bin/filament-v5 (filament/upgrade is already in require-dev)
php artisan kit:install --force   # reinstalls from scratch (deletes the SQLite file) and asks again
php artisan kit:install --custom   # redoes only name and colour, without touching the database
php artisan kit:install --no-custom   # installs without asking anything
php artisan kit:install --no-npm      # skips installing and building the front-end assets
php artisan kit:install --no-seed     # doesn't seed the database (roles, initial user, AI agents)
php artisan kit:install --no-support  # skips the invitation to star the kit on GitHub
#   --create-project is internal to post-create-project-cmd: removes what only serves the kit's own repository
php artisan kit:admin             # changes the administrator's e-mail and password (asks for confirmation)
php artisan kit:admin --email=x --senha=y --force   # no prompts — avoid it: the password lands in the shell history
php artisan kit:info              # shows how the project is customized and where each value comes from
php artisan kit:update            # brings in improvements from a new kit version
php artisan kit:tenancy           # turns on multi-tenancy (opt-in)

The quality deep dives that used to sit under this section — FilaCheck, Rector, the test suite, the README images and the SFDIPOT sweep — are in Code quality.

Customize your project

The installer already asks the first five — the list below is for changing them later, or for whoever skipped the questions.

php artisan kit:info shows the current value of every item below, and whether it comes from the database or the .env.

#	What	Where	Asked during installation?
1	Name	`APP_NAME` in `.env`	✅
2	Database	the `DB_*` block in `.env`	✅
3	Seeder credentials	`KIT_ADMIN_EMAIL` / `KIT_ADMIN_PASSWORD` in `.env`	✅
4	Primary color	`KIT_COR_PRIMARIA` in `.env` (a color name from the Filament palette), or `KIT_COR_PRIMARIA_HEX` with a free hex value — the hex beats the name when both are filled	✅
5	Multi-tenancy	`php artisan kit:tenancy`, and the displayed term in `config/kit.php` → `tenancy.label`	✅
6	Login artwork	none: it shows the application name (`APP_NAME`) on its own. To replace it with your own image, upload it at `/admin/configuracoes-do-kit`	✅ (via the name)
7	Panel access	each user’s role (`/admin` → Roles, the Painel field); the rule that reads it is `App\Models\User::canAccessPanel()`	—
8	Permission matrix	`database/seeders/PapeisSeeder.php`	—
9	Health checks	`KitServiceProvider::configureHealthChecks()`	—
10	Commands in the UI	`config/command-center.php`	—
11	Backups	destination and schedule in `config/backup.php`	—
12	AI agent	`/admin` → AI Agents (or `database/seeders/AssistenteSeeder.php`)	—
13	Panel languages	`config/kit.php` → `idiomas` (a list of locales; with only one, the switcher doesn’t show)	—
14	Trail retention	`KIT_RETENCAO_EXCECOES_DIAS` / `KIT_RETENCAO_EMAILS_DIAS` in `.env`	—
15	Media disk	`MEDIA_DISK` in `.env` (`local` by default — private, served through a signed URL)	`php artisan kit:midia-privada` migrates media already written to a public disk
16	CSV import and export	the Action in each `app/Filament/*/Pages/List.php` (on or commented out); the permission in `config/filament-shield.php` → `policies.methods`; history retention in `KIT_RETENCAO_IMPORTACOES_DIAS` / `KIT_RETENCAO_EXPORTACOES_DIAS` in `.env`	reseed `ShieldPermissionsSeeder` + `PapeisSeeder` after touching the config

The last eleven are not asked because they are code or screen data, not a value that fits in a terminal prompt. The installer lists them in the final summary, each with its file.

⚠️ Item 5 is the only one that is not “edit a file” once installed: kit:tenancy runs migrate:fresh --seed and deletes your data. It requires a clean git tree and an explicit confirmation. Answered during installation it deletes nothing — the database does not exist yet, and that is the right moment to decide.

The primary color applies to all three panels. With multi-tenancy on, each organization’s color wins over it inside /app/{slug} — /admin and /infra keep the project’s one. For a full palette, and not just primary, the way is still ->colors([...]) in each app/Providers/Filament/*PanelProvider.php.