Kibot CLI
kibot
es una interfaz de línea de comandos que funciona como orquestador para gestionar el flujo de procesos que se dan entre Kibot y el middleware Kibot.Quiron.Middleware.
Instalación
Como requisito es necesario tener instalado el entorno de ejecución de JavaScript NodeJS. Se recomienda instalar la versión LTS.
Instalar el CLI usando el gestor de paquetes npm
npm install --global @kibot/cli
# o más corto
npm i -g @kibot/cli
Desinstalación
npm uninstall --global @kibot/cli
# o más corto
npm un -g @kibot/cli
Documentación
Comandos principales
- help: muestra ayudas sobre cualquier comando
-
config: permite gestionar el archivo de configuración global
- reveal: muestra la ruta del archivo de configuración
- preview: muestra la configuración actual
- remove: elimina el archivo de configuración del disco
- create: crea un nuevo archivo de configuración
-
db: permite realizar operaciones de lectura en la base de datos
- test: comprueba el estado de la conexión
-
appointments: permite gestionar las citas
- list: muestra las citas de la tabla ChatbotCitas en formato JSON o en una tabla
- prepare: carga las citas en la tabla ChatbotCitas antes de ser subidas
- upload: toma las citas de la tabla ChatbotCitas y las sube a la nube
help
Usage: kibot [options] [command]
Options:
-h, --help display help for command
Commands:
test-db
appointments
help [command] display help for command
config
Usage: kibot config [options] [command]
Options:
-h, --help display help for command
Commands:
reveal
preview
remove
create [options] <app>
help [command] display help for command
reveal
Usage: kibot config reveal [options]
Options:
-h, --help display help for command
preview
Usage: kibot config preview [options]
Options:
-h, --help display help for command
remove
Usage: kibot config remove [options]
Options:
-h, --help display help for command
create
Usage: kibot config create [options] <app>
Options:
-c --client <client> Client ID
-db --database <database> Database name
-s --server <server> Server instance name
-usr --user <user> Username
-pwd --password <password> Password
-uw --uploadwebhook <uploadwebhook> Webhook to upload appointments
-h, --help display help for command
db
Usage: kibot db [options] [command]
Options:
-h, --help display help for command
Commands:
test
help [command] display help for command
test
Usage: kibot db test [options]
Options:
-h, --help display help for command
appointments
Usage: kibot appointments [options] [command]
Options:
-h, --help display help for command
Commands:
list [options]
prepare
upload
help [command] display help for command
list
Usage: kibot appointments list [options]
Options:
-f --format <format> display data in JSON or Table format (default: "json")
-h, --help display help for command
prepare
Usage: kibot appointments prepare [options]
Options:
-h, --help display help for command
upload
Usage: kibot appointments upload [options]
Options:
-h, --help display help for command
Configuración
La configuración del CLI se maneja a través de un archivo JSON
Este es un ejemplo de su estructura.
{
"apps": {
"quiron": {
"client": 32,
"database": {
"database": "",
"server": "",
"user": "",
"password": "",
"options": {
"trustedConnection": true,
"trustServerCertificate": true
}
},
"webhooks": {
"uploadAppointments": "https://kibot-quiron-middleware.azurewebsites.net/api/chatbotcita/create"
}
}
}
}
Este es un ejemplo del comando que se puede utilizar para crear el archivo.
kibot config create quiron --client 32 --database Quiron --server JUAN-WICK --uploadwebhook https://kibot-quiron-middleware.azurewebsites.net/api/chatbotcita/create
# o más corto
kibot config create quiron --c 32 --db Quiron --s JUAN-WICK --uw https://kibot-quiron-middleware.azurewebsites.net/api/chatbotcita/create
Otros
- Doumentación de Kibot
- Documentación de Kibot.Quiron.Middleware
- Documentación de Kibot.Quiron.Listener