Aller au contenu

Référence CLI

Les commandes utilisent cette forme

Syntaxe de commande
telegram-commander <command> [flags]

--config / -c est obligatoire pour les commandes qui chargent la configuration. Le chemin peut être relatif au dossier de travail actuel ou absolu. Le contenu du fichier est décrit dans Configuration.

Si vous débutez, Exécuter dans la CLI présente ces commandes dans leur ordre d’utilisation.

Commandes

run

Exécute le bot au premier plan.

Démarrer le bot au premier plan

Démarrer le bot
telegram-commander run --config /path/to/configfile.yaml

Les modifications nécessitent un redémarrage

Le bot lit la configuration une fois au démarrage. Après une modification, redémarrez le processus, par exemple avec systemctl restart telegram-commander.

validate

Valide hors ligne la configuration, les fonctions et les références des boutons.

Vérifier la configuration hors ligne ou en ligne

Valider la configuration
telegram-commander validate --config /path/to/configfile.yaml
telegram-commander validate --config /path/to/configfile.yaml --online

--online nécessite Internet

Avec --online, la vérification demande aussi à Telegram si le jeton du bot fonctionne. La machine doit donc pouvoir joindre Telegram.

version

Affiche la version du programme.

fmt

Affiche proprement un fichier de configuration YAML.

Afficher ou enregistrer le YAML formaté

Formater un fichier de configuration
telegram-commander fmt --config /path/to/configfile.yaml
telegram-commander fmt --config /path/to/configfile.yaml -w

environ

Affiche les variables d’environnement du processus, utile pour diagnostiquer les unités de service.

list-functions

Liste les fonctions intégrées et personnalisées chargées. Utilisez cette commande pour confirmer que vos fichiers ont été trouvés. Consultez Fonctions.

Afficher toutes les fonctions disponibles

Lister les fonctions disponibles
telegram-commander list-functions --config /path/to/configfile.yaml

completion

Génère les scripts de complétion du shell :

Choisir votre shell

Générer un script de complétion
telegram-commander completion bash
telegram-commander completion zsh
telegram-commander completion fish
telegram-commander completion powershell

manpage

Écrit une page de manuel sur la sortie standard.

Pages associées