Artisan Command Reference Overview
Uplinkr is a CLI-first monitoring tool. All interactions are performed via Artisan commands, grouped by responsibility.
This page gives you a high-level overview of all available commands and helps you quickly find the right one.
Command Categories
Section titled “Command Categories”Uplinkr commands are grouped into the following categories:
- Project Management – Create, update, enable or archive projects
- Probe Management – Define and manage monitored URLs
- Execution – Run probes manually or in bulk
- Alerts – Configure and evaluate alert rules
- Analysis – Analyze stored probe results
- Maintenance – Clean up or prune stored data
Project Management
Section titled “Project Management”Commands related to the lifecycle and metadata of projects.
| Command | Description |
|---|---|
uplinkr:project:init | Initialize a new project |
uplinkr:project:update | Update project label or description |
uplinkr:project:list | List all existing projects |
uplinkr:project:archive | Archive a project and its results |
uplinkr:project:disable | Disable a project |
uplinkr:project:enable | Enable a previously disabled project |
Probe Management
Section titled “Probe Management”Commands for defining and maintaining monitored URLs (probes).
| Command | Description |
|---|---|
uplinkr:probe:url | Manually probe a single URL |
uplinkr:project:add:probe | Add a probe to a project |
uplinkr:project:remove:probe | Remove a probe from a project |
Execution
Section titled “Execution”Commands that trigger probe execution.
| Command | Description |
|---|---|
uplinkr:project:run-probes | Run all probes for all active projects |
uplinkr:project:run-selected-probe | Run probes for a specific project |
Alerts
Section titled “Alerts”Commands for configuring and evaluating alert rules.
| Command | Description |
|---|---|
uplinkr:project:alerts | Configure alert thresholds and channels |
uplinkr:project:alert:decision | Evaluate whether alerts should be triggered |
Analysis
Section titled “Analysis”Commands that summarize and analyze probe results.
| Command | Description |
|---|---|
uplinkr:project:analyze | Analyze stored probe results |
Maintenance
Section titled “Maintenance”Commands for cleanup and housekeeping.
| Command | Description |
|---|---|
uplinkr:install | Publish config & language files (optional scheduler setup) |
uplinkr:prune | Delete old results or wipe all data |
Experimental & Work in Progress
Section titled “Experimental & Work in Progress”- Advanced alert configuration options
- Alert CRUD commands (
add,list,remove,toggle) - Probe enable / disable commands
- Extended probe listing and update commands
➡️ See: Roadmap & Upcoming Features
Command Help
Section titled “Command Help”Every command supports the built-in Artisan help output:
php artisan uplinkr:project:init --help