¡Estoy emocionado de anunciar el lanzamiento oficial de la versión 1.0.0 del Asistente en Terminal con Hugging Face! Este proyecto es un asistente inteligente que opera directamente desde la terminal, utilizando modelos de Hugging Face para ofrecer respuestas útiles y mantener conversaciones naturales.
Características Principales ✨
- Interfaz Intuitiva: Interactúa fácilmente con el asistente desde tu terminal.
- Historial de Conversación: Mantiene un seguimiento de los mensajes durante la sesión.
- Indicador de Proceso: Animación lunar que indica cuando el asistente está "pensando".
- Interfaz Colorida: Utiliza chalk para una experiencia visual mejorada.
- Configuración Segura: Utiliza variables de entorno para proteger tu información sensible.
Cómo Empezar 🚀
- Clona el repositorio:
git clone git@github.com:aledjv22/terminal-assistant.git
- Instala las dependencias:
npm install
- Configura las variables de entorno:
- Crea un archivo
.env
basado en.env.example
. - Configura las siguientes variables en
.env
:HUGGING_FACE_TOKEN=tu_token_aquí MODEL=modelo_a_usar # Por defecto: mistralai/Mixtral-8x7B-Instruct-v0.1 MAX_TOKENS=tokens_máximos # Por defecto: 1000 TEMPERATURE=temperatura # Por defecto: 0.1 SEED=semilla # Por defecto: 42 ROLE_SYSTEM_CONTENT=rol_del_asistente # Por defecto: ''
- Crea un archivo
Uso 🖥️
- Inicia el asistente:
npm start
- Interacción:
- Escribe tus preguntas o comentarios en la terminal.
- El texto del usuario aparece en azul gracias a la función
messages.showUserInput
. - El asistente procesa tu entrada y muestra una animación con
loader.start
. - Las respuestas del asistente aparecen en verde usando
messages.showAssistantMessage
.
- Salir:
- Para finalizar la sesión, puedes escribir palabras clave definidas en
exitHandler.exitWords
.
- Para finalizar la sesión, puedes escribir palabras clave definidas en
Configuración de Alias Linux (Opcional) 🔧
Para ejecutar el asistente desde cualquier ubicación, puedes configurar un alias:
-
Navega al directorio del proyecto y obtiene la ruta absoluta:
cd ruta/del/proyecto/terminal-assistant pwd
-
Agrega el alias a tu archivo de configuración de shell (reemplaza
RUTA_OBTENIDA
):- Para Bash:
echo 'alias assistant="cd RUTA_OBTENIDA && npm start"' >> ~/.bashrc source ~/.bashrc
- Para Zsh:
echo 'alias assistant="cd RUTA_OBTENIDA && npm start"' >> ~/.zshrc source ~/.zshrc
- Para Bash:
-
Ahora puedes iniciar el asistente con:
assistant
Captura de Pantalla 📸
Figura 1: Interacción con el asistente en la terminal.
Agradecimientos 🤝
Aunque actualmente soy el único desarrollador, ¡todas las contribuciones son bienvenidas! Si deseas colaborar:
- Reporta Problemas: Abre una issue para informar errores o sugerencias.
- Contribuye al Código: Haz un fork del repositorio, crea una rama, realiza tus cambios y envía un pull request.
¡Gracias por tu interés en este proyecto! Espero que este asistente te sea de gran ayuda en tus tareas diarias. 🎉