Skip to content
Uplinkr

List and Inspect Existing Projects

Command

Section titled “Command”
Terminal window
php artisan uplinkr:project:list

Description

Section titled “Description”

Lists projects based on each project’s settings.json and enriches output with state data from state.json.

For each project, the command shows:

  • project name (project) and label (label)
  • project status (enabled or disabled)
  • optional description (description)
  • alert settings as a table (alerts)
  • configured probes/checks as a table (probes)
  • state summary as a table (total_failures, last_notification)

Options

Section titled “Options”
  • --project=: Show only one specific project.

Usage Examples

Section titled “Usage Examples”
Terminal window
php artisan uplinkr:project:list
Terminal window
php artisan uplinkr:project:list --project=my-project

Output Format

Section titled “Output Format”

Project header line

Section titled “Project header line”

Project: <project> | <label> | <status>

Status color:

  • enabled is displayed in green
  • disabled (or any non-enabled status) is displayed in red

Alerts table

Section titled “Alerts table”

The Alerts: section is rendered as a table with these columns:

  • Enabled
  • Trigger After Failures
  • Cooldown Minutes
  • Latency Threshold (ms)
  • Trigger After Slow
  • Channels

Probes/checks table

Section titled “Probes/checks table”

The probes/checks section is rendered as a table with:

  • Method
  • URL

State table

Section titled “State table”

The State: section is rendered as a table with:

  • Total Failures
  • Last Notification

Example output

Section titled “Example output”
Project: my-project | Main Website | enabled
Description: Public website monitoring
Alerts:
+---------+------------------------+------------------+------------------------+--------------------+----------+
| Enabled | Trigger After Failures | Cooldown Minutes | Latency Threshold (ms) | Trigger After Slow | Channels |
+---------+------------------------+------------------+------------------------+--------------------+----------+
| true    | 5                      | 60               | 1000                   | 10                 | mail,log |
+---------+------------------------+------------------+------------------------+--------------------+----------+
+--------+-------------------------------+
| Method | URL                           |
+--------+-------------------------------+
| GET    | https://example.com/health    |
| POST   | https://example.com/status    |
+--------+-------------------------------+
State:
+----------------+---------------------+
| Total Failures | Last Notification   |
+----------------+---------------------+
| 12             | 2026-02-28 05:15:02 |
+----------------+---------------------+

If --project is not found

Section titled “If --project is not found”

The command returns an error and prints all available project names:

Project "missing-project" not found. Please check the spelling.
Available projects:
- my-project
- api-service

Return Codes

Section titled “Return Codes”
  • 0 (SUCCESS): List displayed successfully
  • 1 (FAILURE): Selected project was not found