Saltar a contenido

Referencia de la CLI

Los comandos usan esta forma

Sintaxis del comando
telegram-commander <command> [flags]

--config / -c es obligatorio para los comandos que cargan la configuración. La ruta puede ser relativa al directorio de trabajo actual o absoluta. El contenido del archivo se documenta en Configuración.

Si acaba de empezar, Ejecutar en la CLI muestra estos comandos en el orden en que los usará.

Comandos

run

Ejecuta el bot en primer plano.

Iniciar el bot en primer plano

Ejecutar el bot
telegram-commander run --config /path/to/configfile.yaml

Los cambios de configuración requieren un reinicio

El bot lee la configuración una vez al iniciarse. Después de modificar el archivo, reinicie el proceso, por ejemplo con systemctl restart telegram-commander.

validate

Valida sin conexión la configuración, las funciones y las referencias de botones.

Comprobar la configuración sin conexión o en línea

Validar la configuración
telegram-commander validate --config /path/to/configfile.yaml
telegram-commander validate --config /path/to/configfile.yaml --online

--online necesita Internet

Con --online, la comprobación también pregunta a Telegram si funciona el token del bot, por lo que la máquina debe poder conectarse a Telegram.

version

Muestra la versión del programa.

fmt

Muestra un archivo de configuración YAML con un formato uniforme.

Mostrar o guardar YAML con formato

Dar formato a un archivo de configuración
telegram-commander fmt --config /path/to/configfile.yaml
telegram-commander fmt --config /path/to/configfile.yaml -w

environ

Muestra las variables de entorno del proceso, útiles para depurar unidades de servicio.

list-functions

Enumera las funciones integradas y personalizadas cargadas. Úselo para confirmar que se encontraron sus archivos. Consulte Funciones.

Mostrar todas las funciones disponibles

Enumerar las funciones disponibles
telegram-commander list-functions --config /path/to/configfile.yaml

completion

Genera scripts de completado del shell:

Elegir el shell que usa

Generar un script de completado
telegram-commander completion bash
telegram-commander completion zsh
telegram-commander completion fish
telegram-commander completion powershell

manpage

Escribe una página de manual en stdout.

Páginas relacionadas