laravel-client maintained by kistn
kistn/laravel-client
Laravel package wrapping kistn/php-client. Provides auto-discovery service provider and an Artisan command.
Installation
composer require kistn/laravel
Auto-discovered via extra.laravel.providers — no manual registration needed.
Configuration
Publish the config file:
php artisan vendor:publish --tag=kistn-config
Set credentials in .env:
KISTN_BASE_URL=https://your-server.example
KISTN_PROJECT_ID=your-project-uuid-here
KISTN_TOKEN=your-api-token-here
work_dir defaults to base_path() (project root). cache_path defaults to storage_path('app/private/kistn/.inventory.hash').
File transmission
Every push sends the package inventory (names, versions, dependency flags) and your local
audit findings. Your lock and manifest files (composer.lock, composer.json,
vendor/composer/installed.json, package-lock.json, package.json) are not uploaded
unless you opt in per ecosystem:
KISTN_TRANSMIT_COMPOSER_FILES=false # false (default) | true | on-demand
KISTN_TRANSMIT_NPM_FILES=false # false (default) | true | on-demand
false— never upload (default; also used for any unrecognized value).true— upload whenever the package list changed.on-demand— upload only when the package manager CLI is unavailable locally, so the server can run the audit instead.
Uploaded files let the Kistn server run its own audit and cross-check your local findings. They contain your full dependency tree, so enable this only if you are fine sharing that data with the server.
Usage
php artisan kistn:push
Runs all configured collectors (Composer + npm) and pushes changed inventory to the server. Safe to run on every deploy — skips push when nothing changed.
How It Works
The ServiceProvider binds InventoryPusher as a singleton, wiring up:
InventoryClientbacked by GuzzleComposerCollectorpointing atwork_dir, withinstalled.jsonpreferred overcomposer.lockwhen presentNpmCollectorpointing atwork_dirLocalHashCacheatcache_path
See kistn/php-client for the full push flow.
Testing
composer run pest
composer run ci:check # phpstan + rector:check + pest