Skip to content

Ekisa-Team/kibot-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

59 Commits

Repository files navigation

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

Ejecutar el siguiente comando desde PowerShell para instalar Kibot CLI en su ubicaci贸n por defecto (c:\Kibot CLI)

Windows 64 bits

Invoke-Expression (New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/Ekisa-Team/kibot-cli/main/script/install-amd64.ps1')

# o m谩s corto
iwr -useb https://raw.githubusercontent.com/Ekisa-Team/kibot-cli/main/script/install-amd64.ps1 | iex

Windows 32 bits

Invoke-Expression (New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/Ekisa-Team/kibot-cli/main/script/install-386.ps1')

# o m谩s corto
iwr -useb https://raw.githubusercontent.com/Ekisa-Team/kibot-cli/main/script/install-386.ps1 | iex

Una vez instalado, ejecutar kibot help para recibir instrucciones y verificar que la instalaci贸n fue exitosa.

Nota: si obtiene un error al momento de intentar instalar, es posible que deba cambiar la pol铆tica de ejecuci贸n de PowerShell con el siguiente comando:

Set-ExecutionPolicy RemoteSigned -scope CurrentUser

Nota: en caso de que el binario instalado sea de 32 bits, se debe utilizar el comando kibot32 en lugar de kibot

Nota: si desea realizar una instalaci贸n manual, los binarios en las arquitecturas de 32 y 64 bits se encuentran disponibles en la p谩gina de releases, en la secci贸n de assets.

Desinstalaci贸n

Ejecutar el siguiente comando desde PowerShell para desinstalar Kibot CLI

Invoke-Expression (New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/Ekisa-Team/kibot-cli/main/script/uninstall.ps1')

# o m谩s corto
iwr -useb https://raw.githubusercontent.com/Ekisa-Team/kibot-cli/main/script/uninstall.ps1 | iex

Documentaci贸n

Comandos disponibles

completion      // Genera script de autocompletado para un shell especificado

help            // Ayudas acerca de cualquier comando

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

completion

Usage:
  kibot completion [command]

Subcommands:
  bash          // Genera script de autocompletado para bash
  fish          // Genera script de autocompletado para fish
  powershell    // Genera script de autocompletado para powershell
  zsh           // Genera script de autocompletado para zsh

Flags:
  -h, --help    // Ayudas para el comando completion

help

Usage:
  kibot [flags]
  kibot [command]

Subcommands:
  completion         // Ayudas para el comando completion
  help               // Ayudas para kibot
  prepare            // Ayudas para el comando prepare
  upload             // Ayudas para el comando upload

Flags:
  -h, --help         // Ayudas para kibot

Global flags:
  -c, --config       // Ruta del archivo de configuraci贸n (con extensi贸n)

prepare

Usage:
  kibot prepare [flags]

Flags:
  -h, --help         // Ayudas para el comando prepare

Global flags:
  -c, --config       // Ruta del archivo de configuraci贸n (con extensi贸n)

upload

Usage:
  kibot upload [flags]

Flags:
  -h, --help         // Ayudas para el comando upload

Global flags:
  -c, --config       // Ruta del archivo de configuraci贸n (con extensi贸n)

Configuraci贸n

La configuraci贸n del CLI se maneja a trav茅s de un archivo YAML.

El archivo recibe los siguientes par谩metros:

# Application
client: 32

# Database
connection_string: Data Source=MY_DATASOURCE;Initial Catalog=MY_DATABASE;Integrated Security=True

# Webhooks
upload_webhook_uri: https://ekisa-chatbots-api.azurewebsites.net/api/chatbotcita/create

El CLI buscar谩 ese archivo en las siguientes ubicaciones:

.\kibot-config.yaml                                    Raiz de la carpeta donde se encuentra instalado el ejecutable
$HOME\.config\kibot\kibot-config.yaml                  C:\Users\username\.config\kibot\kibot-config.yaml

Opcionalmente se le puede especificar expl铆citamente la ruta del archivo de configuraci贸n con la bandera global --config al ejectuar cualquier comando transaccional.

Ejemplo:

kibot prepare --config C:\Users\username\Downloads\kibot-config.yaml

贸

kibot prepare -c C:\Users\username\Downloads\kibot-config.yaml

Ver plantilla del archivo de configuraci贸n

Otros