https://github.com/ekisa-team/kibot-cli-node
🧙 Kibot's command line tool written in node
https://github.com/ekisa-team/kibot-cli-node
typescript
Last synced: 2 months ago
JSON representation
🧙 Kibot's command line tool written in node
- Host: GitHub
- URL: https://github.com/ekisa-team/kibot-cli-node
- Owner: Ekisa-Team
- Created: 2022-04-30T21:39:44.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-21T22:00:55.000Z (over 3 years ago)
- Last Synced: 2025-06-09T22:04:48.265Z (6 months ago)
- Topics: typescript
- Language: TypeScript
- Homepage:
- Size: 188 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# **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](https://github.com/Ekisa-Team/Kibot) y el middleware [Kibot.Quiron.Middleware](https://github.com/Ekisa-Team/Kibot.Quiron.Middleware).
## **Instalación**
Como requisito es necesario tener instalado el entorno de ejecución de JavaScript [NodeJS](https://nodejs.org/es/). Se recomienda instalar la versión LTS.
Instalar el CLI usando el gestor de paquetes `npm`
```console
npm install --global @kibot/cli
# o más corto
npm i -g @kibot/cli
```
## **Desinstalación**
```console
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`
```console
Usage: kibot [options] [command]
Options:
-h, --help display help for command
Commands:
test-db
appointments
help [command] display help for command
```
## `config`
```console
Usage: kibot config [options] [command]
Options:
-h, --help display help for command
Commands:
reveal
preview
remove
create [options]
help [command] display help for command
```
#### `reveal`
```console
Usage: kibot config reveal [options]
Options:
-h, --help display help for command
```
#### `preview`
```console
Usage: kibot config preview [options]
Options:
-h, --help display help for command
```
#### `remove`
```console
Usage: kibot config remove [options]
Options:
-h, --help display help for command
```
#### `create`
```console
Usage: kibot config create [options]
Options:
-c --client Client ID
-db --database Database name
-s --server Server instance name
-usr --user Username
-pwd --password Password
-uw --uploadwebhook Webhook to upload appointments
-h, --help display help for command
```
## `db`
```console
Usage: kibot db [options] [command]
Options:
-h, --help display help for command
Commands:
test
help [command] display help for command
```
#### `test`
```console
Usage: kibot db test [options]
Options:
-h, --help display help for command
```
## `appointments`
```console
Usage: kibot appointments [options] [command]
Options:
-h, --help display help for command
Commands:
list [options]
prepare
upload
help [command] display help for command
```
#### `list`
```console
Usage: kibot appointments list [options]
Options:
-f --format display data in JSON or Table format (default: "json")
-h, --help display help for command
```
#### `prepare`
```console
Usage: kibot appointments prepare [options]
Options:
-h, --help display help for command
```
#### `upload`
```console
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.
```json
{
"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.
```console
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](https://github.com/Ekisa-Team/Kibot)
- Documentación de [Kibot.Quiron.Middleware](https://github.com/Ekisa-Team/Kibot.Quiron.Middleware)
- Documentación de [Kibot.Quiron.Listener](https://github.com/Ekisa-Team/Kibot.Quiron.Listener)