Manage Global Uplinkr Settings
Command
Section titled “Command”php artisan uplinkr:settingsDescription
Section titled “Description”Manages global Uplinkr settings stored in storage/app/private/uplinkr/settings.json.
Currently, this command configures the global I’m alive feature:
- enable/disable heartbeat notifications
- configure interval in hours (
1-24) - configure channels (
mail,log,webhook)
When called without options, it prints the current configuration.
Options
Section titled “Options”| Option | Type | Required | Default | Description |
|---|---|---|---|---|
--iam-alive-enabled | boolean | No | unchanged | Enable or disable I’m alive (true/false) |
--iam-alive-interval-hours | integer | No | unchanged | Interval in hours (1-24) |
--iam-alive-channels | string | No | unchanged | Comma-separated channels (mail,log,webhook) |
--force | flag | No | false | Skip confirmation prompt |
Usage Examples
Section titled “Usage Examples”Show current settings
Section titled “Show current settings”php artisan uplinkr:settingsEnable and configure I’m alive
Section titled “Enable and configure I’m alive”php artisan uplinkr:settings \ --iam-alive-enabled=true \ --iam-alive-interval-hours=6 \ --iam-alive-channels=mail,log \ --forceDisable I’m alive
Section titled “Disable I’m alive”php artisan uplinkr:settings --iam-alive-enabled=false --forceUpdate interval/channels only
Section titled “Update interval/channels only”php artisan uplinkr:settings \ --iam-alive-interval-hours=12 \ --iam-alive-channels=webhook \ --forceIf only interval/channels are provided (without
--iam-alive-enabled), Uplinkr enables I’m alive automatically.
Behavior
Section titled “Behavior”- Reads and writes global settings in
storage/app/private/uplinkr/settings.json - Validates interval range (
1-24) and channels (mail,log,webhook) - Asks for confirmation unless
--forceis provided - Prints updated values including
last_sent_at last_sent_atrepresents the last successful heartbeat delivery; internal scheduler retry state is handled separately
Return Codes
Section titled “Return Codes”0(SUCCESS): Settings were shown or updated successfully2(INVALID): Validation failed or process was aborted
Related Topics
Section titled “Related Topics”- Install command - Configure I’m alive during installation
- Storage Structure - Where global settings are stored