README

Aether Client is a Laravel package that allows any client application to easily connect and interact with the Aether Server. With this package, you can manage "actions" and "realms" directly from your Laravel application's command line.

Installation

Install this package in your Laravel project via Composer:

composer require ometra/aether-client:dev-main

Enviroment Setup

Befor using the package, add the following variables to your .env file to connect with Aether Server:

AETHER_BASE_URL=      # URL of your Aether server
AETHER_REALM_ID=      # Realm ID for your application
AETHER_TOKEN=         # Authentication token
AETHER_LOG_LEV=       # Log level (e.g., debug, info, error)

Available Artisan Commands

Each command should be executed from your project root using php artisan. Below you’ll find the main commands provided by the package, grouped by functionality.

Actions

List actions: Displays all actions configured for the application.

 php artisan aether:actions

Create a new action: Launches an interactive wizard for creating a new action, including name, description, and frequency.

php artisan aether:create-action

Update an existing action: Select and modify any registered action.

php artisan aether:update-action

Delete an action: Shows all registered actions and lets you select one to delete from your server.

php artisan aether:delete-action

Update the configuration of an action that belongs to a realm:
Allows updating the relationships and settings between actions and realms.

php artisan aether:update-action-realm

Note

Email addresses must be entered separated by commas, for example:

 user1@example.com,user2@example.com

When one or more email addresses are provided, configuring a cooldown is mandatory.

The cooldown represents the minimum time interval between notifications.

The cooldown format must be HH:MM:SS, for example.

 00:15:00

Notification settings are independent for errors (error) and warnings (warning), meaning that each one can have:

A different list of email recipients
Different threshold values
A different cooldown time

Realms

List realms: Shows all realms registered for your application.

php artisan aether:realms

Create a new realm: Interactive wizard for registering a new realm.

php artisan aether:create-realm

Update a realm: Select a realm to rename it and/or add new action.

php artisan aether:update-realm

Monitoring

Sends a specific event (e.g., completion, error, etc.) to the Aether server.

  php artisan aether:report {action} {status?}

🔹 action (required): Name of the action to report
🔹 status (optional): Status or extra message

Aditional information

Note: By default, every application includes a special heartbeat action to check that the environment is running properly.

ometra / aether-client

Maintainers

Details