From cb42b3a1c0fb06fcc82f4e202804c7d3c879f78a Mon Sep 17 00:00:00 2001 From: "Mauro Rosero P." Date: Wed, 19 Mar 2025 20:27:28 -0500 Subject: [PATCH] [DOCS] Actualizar README.md para reflejar nuevos nombres de scripts y cambios MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Actualizar nombres de scripts (claude_install.sh, ghadmin_install.sh, etc.) - Añadir información sobre cortana_unalias.sh y jarvis_token.sh - Corregir información sobre estructura de directorios - Actualizar ejemplos de comandos para reflejar nuevos nombres - Mejorar sección de contribución con plantilla de bash.header 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- README.md | 87 ++++++++++++++++++++++++------------------------------- 1 file changed, 38 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index 55c8372..877f9ee 100644 --- a/README.md +++ b/README.md @@ -47,12 +47,14 @@ bin/update.sh | Comando | Descripción | |---------|-------------| -| `bin/cortana_install.sh` | Instala Claude Code CLI (Cortana) | -| `bin/cortana_install.sh -u` | Desinstala Claude Code CLI | -| `bin/cortana_token.sh` | Gestiona la encriptación del token de Cortana vía SOPS | -| `bin/cortana_alias.sh` | Configura alias de línea de comandos para Cortana | -| `bin/cortana_enable.sh` | Activa el uso de Cortana | -| `bin/cortana_disable.sh` | Desactiva temporalmente Cortana | +| `bin/claude_install.sh` | Instala Claude Code CLI | +| `bin/claude_install.sh -u` | Desinstala Claude Code CLI | +| `bin/cortana_token.sh` | Gestiona la encriptación del token de Claude Code vía SOPS | +| `bin/jarvis_token.sh` | Gestiona la encriptación del token de Jarvis vía SOPS | +| `bin/cortana_alias.sh` | Configura alias 'cortana' para Claude Code | +| `bin/cortana_unalias.sh` | Elimina el alias 'cortana' | +| `bin/cortana_enable.sh` | Activa el alias 'cortana' permanentemente | +| `bin/cortana_disable.sh` | Desactiva temporalmente el alias 'cortana' | ### Herramientas para Editores de Código @@ -64,11 +66,10 @@ bin/update.sh | Comando | Descripción | |---------|-------------| -| `bin/ghcli_install.sh` | Instala GitHub CLI (gh) con soporte multiplataforma | -| `bin/glcli_install.sh` | Instala GitLab CLI (glab) con múltiples métodos de instalación | -| `bin/fjcli_install.sh` | Instala Forgejo/Codeberg CLI vía Cargo | -| `bin/cversadm_token.sh` | Gestiona tokens de acceso para plataformas de control de versiones de forma segura | -| `bin/fj_login.sh` | Inicia/cierra sesión en Forgejo usando tokens encriptados con SOPS | +| `bin/ghadmin_install.sh` | Instala GitHub CLI (gh) con soporte multiplataforma | +| `bin/gladmin_install.sh` | Instala GitLab CLI (glab) con múltiples métodos de instalación | +| `bin/forgejo_login.sh` | Inicia/cierra sesión en Forgejo usando tokens encriptados con SOPS | +| `bin/cversion_token.sh` | Gestiona tokens de acceso para plataformas de control de versiones de forma segura | ### Seguridad y Acceso @@ -102,25 +103,28 @@ El directorio `$HOME/devs` sirve como área principal de desarrollo donde se ges Si desea usar Docker en lugar de Podman, debe instalarlo manualmente antes de ejecutar `bootstrap.sh`. -### Configuración de Claude Code (Cortana) +### Configuración de Claude Code MRDevs Tools facilita el trabajo con herramientas de IA como Claude Code CLI: ```bash # Instalación -bin/cortana_install.sh +bin/claude_install.sh # Gestión del token de forma segura bin/cortana_token.sh -# Crear alias para facilitar su uso +# Crear alias para facilitar su uso (cortana = claude) bin/cortana_alias.sh -# Habilitar uso de Cortana +# Habilitar uso del alias permanentemente bin/cortana_enable.sh -# Deshabilitar temporalmente Cortana +# Deshabilitar temporalmente el alias bin/cortana_disable.sh + +# Eliminar el alias (si es necesario) +bin/cortana_unalias.sh ``` El token se encripta usando SOPS y se almacena de forma segura en `$HOME/.cortana/cortana.sops.yaml`. @@ -150,7 +154,7 @@ MRDevs Tools incluye scripts para simplificar la instalación de CLIs para difer ```bash # Instalación automatizada -bin/ghcli_install.sh +bin/ghadmin_install.sh ``` El script detecta tu sistema operativo y utiliza el método de instalación más adecuado: @@ -165,7 +169,7 @@ Para aprender a usar GitHub CLI, consulta la [documentación oficial de GitHub C ```bash # Instalación automatizada -bin/glcli_install.sh +bin/gladmin_install.sh ``` El script prioriza los métodos de instalación en este orden: @@ -176,24 +180,11 @@ El script prioriza los métodos de instalación en este orden: Para aprender a usar GitLab CLI, consulta la [documentación oficial de GitLab CLI](https://gitlab.com/gitlab-org/cli/-/blob/main/docs/index.md). -#### Forgejo/Codeberg CLI - -```bash -# Instalación automatizada -bin/fjcli_install.sh -``` - -El script instala la CLI mediante Cargo (el gestor de paquetes de Rust): -- Verifica si Cargo está instalado y lo instala si es necesario -- Instala codeberg-cli que es compatible con servidores Forgejo - -Para aprender a usar Codeberg CLI (compatible con Forgejo), consulta la [documentación en el repositorio de Codeberg CLI](https://codeberg.org/RobWalt/codeberg-cli). - #### Gestión de tokens para control de versiones ```bash # Gestión segura de tokens de acceso -bin/cversadm_token.sh +bin/cversion_token.sh ``` Este script proporciona una interfaz para gestionar tokens de acceso para diferentes plataformas: @@ -207,14 +198,14 @@ Este script proporciona una interfaz para gestionar tokens de acceso para difere ```bash # Iniciar sesión en Forgejo usando el token encriptado -bin/fj_login.sh +bin/forgejo_login.sh # Cerrar sesión de Forgejo -bin/fj_login.sh --logout +bin/forgejo_login.sh --logout ``` Este script facilita la autenticación con Forgejo/Codeberg CLI (berg): -- Utiliza el token almacenado y encriptado por cversadm_token.sh +- Utiliza el token almacenado y encriptado por cversion_token.sh - Desencripta automáticamente el token usando SOPS - Detecta la URL de Forgejo basándose en la configuración de git - Configura la variable BERG_BASE_URL con la URL detectada @@ -329,7 +320,7 @@ bin/ ### Componentes Principales -- **Bibliotecas Base**: Conjunto de funciones reutilizables (`base.lib`, `bootstrap.lib`, `developers.lib`, etc.) +- **Bibliotecas Base**: Conjunto de funciones reutilizables (`base.lib`, `bootstrap.lib`, `developers.lib`, `console.lib`, etc.) - **Sistema de Mensajes**: Soporte multilingüe para internacionalización - **Gestión de Configuración**: Archivos de configuración centralizados, plantillas .gitignore por tipo de proyecto - **Herramientas de Automatización**: Scripts y playbooks de Ansible @@ -360,19 +351,17 @@ Para contribuir al proyecto: - `[INIT]` - Inicialización de proyecto o componente - `[REFACTORED]` - Reestructuración de código sin cambios funcionales - `[MODIFIED]` - Cambios menores o ajustes -3. Para archivos Python, use la plantilla de encabezado que está en `bin/config/python.head`: - ```python - #!/usr/bin/env python3 - # -*- coding: utf-8 -*- - """ - Programa: nombre_archivo.py - Descripción: Breve descripción del programa - Autor: Su Nombre - Creación: Fecha de creación - Actualización: Fecha de última actualización - Versión: X.Y - Licencia: AGPL - """ +3. Para scripts bash, use la plantilla de encabezado que está en `bin/config/bash.header`: + ```bash + #!/bin/bash + # + # Script: nombre_archivo.sh + # Description: Breve descripción del script + # Created: YYYY/MM/DD HH:MM:SS + # Modified: YYYY/MM/DD HH:MM:SS + # [Author] Su Nombre + # + # Derechos de Autor (C) [YYYY] [Su Nombre ] ``` 4. Documente cualquier nueva funcionalidad añadida