Interface en Ligne de Commande

La CLI Apprise (apprise) est un outil léger en ligne de commande qui vous permet d’envoyer des notifications vers pratiquement n’importe quel service directement depuis votre terminal. Elle est idéale pour les administrateurs système, les ingénieurs DevOps et les scripts d’automatisation.

La CLI est l’une des portes d’entrée d’Apprise. Elle utilise les mêmes URL de notification que le reste, et peut s’adresser à un serveur API Apprise plutôt que d’envoyer directement.

Installer la CLI

La commande apprise est incluse dans l’installation de base d’Apprise.

La plupart des utilisateurs l’installent via pip install apprise. Si vous utilisez uv, uv tool install apprise fait la même chose.

Les images Docker ciblent principalement Apprise API, même si la CLI reste disponible dans le conteneur pour un usage opérationnel.

Pour toutes les options d’installation, consultez Installation.

Utilisation de base

La syntaxe est volontairement intuitive. Il vous suffit de fournir les détails de la notification et les URL de destination.

# Syntaxe générale
apprise -t "Titre" -b "Corps" "service-url://..."

Envoyer une notification simple

Pour envoyer une notification, fournissez un titre (-t) et un corps (-b), suivis d’une ou plusieurs URL Apprise.

# Envoyer une notification vers Discord
apprise -t "Tâche terminée" -b "La sauvegarde s'est terminée avec succès." \
    "discord://webhook_id/webhook_token"

Chaîner plusieurs services

Vous pouvez notifier plusieurs services à la fois en les listant à la suite. Par défaut, Apprise envoie les notifications de manière asynchrone pour de meilleures performances.

Utilisez --disable-async pour envoyer les notifications de manière synchrone, en traitant chaque service un par un dans leur ordre de chargement.

# Notifier Discord et l'e-mail simultanément
apprise -vv -t "Alerte serveur" -b "Utilisation CPU élevée détectée." \
   -n "warning" \
   "discord://webhook_id/webhook_token" \
   "mailto://user:pass@gmail.com"

Astuce

Ajouter -v (mode verbeux) est utile pour le débogage. Cela affiche l’état de livraison et des informations de diagnostic dans la console. La verbosité augmente à chaque v supplémentaire (par exemple -vv, -vvv), les niveaux plus élevés produisant une sortie plus détaillée.

Lecture depuis l’entrée standard (stdin)

La CLI fonctionne naturellement avec l’entrée standard (stdin). Si vous ne spécifiez pas de corps (-b), Apprise lit ce qui arrive par le pipe. C’est idéal pour surveiller des journaux ou capturer la sortie d’une commande.

# Envoyer le contenu d'un fichier
cat /proc/cpuinfo | apprise -t "Infos CPU" \
   "mailto://user:pass@gmail.com"

# Envoyer le résultat d'une commande
uptime | apprise "discord://webhook_id/webhook_token"

Charger une configuration

Bien que vous puissiez passer les URL directement à la commande, il est souvent plus propre d’utiliser un fichier de configuration. Cela garde les secrets hors de votre historique de commandes et facilite la gestion de groupes de notification complexes.

# Charger la configuration depuis un fichier et envoyer un message
apprise --config "/etc/apprise/config.yml" \
    --body "Le système va être arrêté pour maintenance"

Pour plus de détails sur la structure des fichiers de configuration, consultez le guide Configuration.