Instalación y uso de la CLI

Esta guía explica cómo instalar Remy CLI en macOS, iniciar sesión, ejecutar tareas en proyectos locales, retomar chats, actualizar la CLI y enviar comentarios.

flowchart LR
    A["Configura Node.js y npm"] --> B["Instala Remy CLI"]
    B --> C["Inicia sesión"]
    C --> D["Ve a tu proyecto"]
    D --> E["Inicia una tarea"]
    E --> F["Revisa y continúa"]

1. Antes de empezar

1.1 Requisitos del sistema y del entorno de ejecución

La CLI requiere Node.js y npm. La instalación estándar de Remy CLI mediante npm no requiere instalar Python ni Rust por separado. Tu proyecto y sus pruebas siguen necesitando su propio entorno y sus dependencias.

Comprueba tu configuración en la terminal:

node --version
npm --version

Ambos comandos deberían mostrar un número de versión. Si falta alguno, descarga el instalador para Mac correspondiente desde el sitio web de Node.js, completa la instalación y abre una terminal nueva. Elige la versión LTS actual antes de instalar Remy.

1.2 Acceso a modelos

Inicia sesión con tu cuenta de Remy para usar los modelos disponibles para ella. El flujo de trabajo estándar no requiere una cuenta independiente con un proveedor de modelos ni una clave de API.

Inicia sesión en la app de escritorio y en la CLI por separado. Aunque hayas iniciado sesión en Remy Desktop, igualmente tienes que iniciar sesión la primera vez que uses la CLI.

2. Instalar y comprobar la CLI

2.1 Instalar Remy CLI

Ejecuta esto en tu terminal:

npm install -g @corepassinc/remy

Espera a que termine la instalación. El instalador selecciona los componentes para tu sistema operativo y la arquitectura de tu entorno de ejecución de Node.js. No necesitas elegir un paquete de CLI distinto para Apple silicon o Intel.

2.2 Comprobar que el comando está disponible

Después de la instalación, ejecuta:

remy --version
remy --help

Si tu terminal no encuentra remy, abre una terminal nueva y revisa las indicaciones sobre la instalación y la ruta del comando en la sección 7.

3. Iniciar sesión y comprobar tu cuenta

3.1 Iniciar sesión

Ejecuta esto en tu terminal:

remy login

1. Completa el inicio de sesión en el navegador que se abre.
2. Vuelve a la terminal y espera el resultado.
3. Cuando veas Signed in as …, continúa con el siguiente paso.

Si el inicio de sesión falla, sigue el mensaje de la terminal para comprobar tu conexión o volver a iniciar sesión.

3.2 Comprobar la cuenta activa

remy whoami

Usa este comando para comprobar la cuenta con la que has iniciado sesión, su ámbito de cuenta actual y el directorio de trabajo. Si usas una cuenta de equipo, confirma que está seleccionado el equipo correcto.

3.3 Comprobar el entorno de ejecución

remy doctor

Usa los resultados para decidir qué necesita atención:

Superar las comprobaciones del entorno de ejecución no verifica una tarea completa. Ejecuta una tarea real para confirmar que el acceso a modelos, el acceso al proyecto y los resultados funcionan como esperas.

Para cerrar sesión en la CLI:

remy logout

4. Iniciar una tarea interactiva en tu proyecto

4.1 Ir a la carpeta de tu proyecto

En tu terminal, ve al proyecto en el que quieres trabajar y luego inicia Remy:

cd "/path/to/project"
remy

Sustituye /path/to/project por la ruta real de tu proyecto local.

También puedes indicar la carpeta del proyecto al iniciar Remy:

remy --workspace "/path/to/project"

Comprueba la carpeta antes de empezar. La CLI trabaja desde el directorio de trabajo actual. Para trabajar en otro proyecto, sal de la sesión interactiva y luego ve a la otra carpeta o inicia Remy con --workspace.

4.2 Elegir un modelo y enviar una tarea

En la interfaz interactiva de Remy:

1. Pulsa F2 o escribe /model para ver los modelos disponibles.
2. Elige un modelo. En los modelos con ajustes de razonamiento, usa Ctrl+U para ajustarlos.
3. Describe tu tarea en el área de entrada y pulsa Enter para enviarla.

En una terminal de macOS, Option+Enter añade una línea nueva. Pulsa Ctrl+G para ver los atajos de teclado y las opciones disponibles.

Elige un modelo antes de iniciar la tarea. La lista que muestra la CLI refleja los modelos disponibles para tu cuenta actual.

4.3 Hacer un cambio pequeño

Elige un problema real de un proyecto existente. El ejemplo siguiente usa el filtrado y la paginación de una lista de pedidos; adapta la funcionalidad y el comportamiento a tu propio proyecto.

Primero, entiende el código relevante:

Lee la documentación de este proyecto y las instrucciones relevantes.
Identifica los archivos, la lógica de filtrado, la lógica de paginación y las pruebas de la lista de pedidos.

Solo analiza. No edites archivos, no instales dependencias, no hagas commit ni push del código.

Cuando hayas comprobado que Remy entiende la tarea, continúa en el mismo chat:

Cuando cambio el filtro de estado en la página 3 de la lista de pedidos, la lista aparece vacía.
Los resultados solo aparecen después de volver a la página 1.

Encuentra y corrige el problema para que al cambiar el filtro se restablezca el número de página.
Cambia solo la lógica relevante, y añade y ejecuta las pruebas relevantes.
Al terminar, resume los archivos modificados, los resultados de las comprobaciones y cualquier comprobación que no hayas podido completar.

Todavía no hagas commit ni push del código.

Si Remy pide más información o una confirmación, lee la solicitud antes de responder. Usa /permissions para ver los permisos de acción del chat actual y sigue las indicaciones de la interfaz para elegir un ajuste.

4.4 Revisar los resultados y continuar

Si tu proyecto usa Git, abre otra ventana de terminal en el mismo proyecto para revisar los cambios sin confirmar:

git status --short
git diff

De forma predeterminada, git diff muestra los cambios no preparados (unstaged) en los archivos con seguimiento. No muestra el contenido de los archivos nuevos ni los cambios preparados (staged). Usa git diff --cached para los cambios preparados y abre directamente los archivos nuevos para revisarlos. Los cambios que veas también pueden incluir trabajo que ya existía antes de empezar la tarea.

Para afinar el resultado, describe en el chat original qué ocurrió, qué esperabas y qué debería cambiar:

Ahora el número de página se restablece, pero la lista no se actualiza.
Debería solicitar datos nuevos en cuanto cambie el filtro.

Corrige solo este problema, añade y ejecuta las pruebas relevantes,
y resume el cambio y los resultados de las comprobaciones. Todavía no hagas commit ni push del código.

4.5 Atajos de teclado habituales

5. Comandos y continuación de chats

5.1 Saber dónde escribir un comando

Ejecuta los comandos de instalación, como npm install, en la terminal de tu sistema, en lugar de enviarlos a Remy como prompts de tarea.

5.2 Comandos interactivos habituales

Antes de iniciar un chat nuevo o retomar uno, termina la tarea actual y revisa los archivos tal como existen realmente en tu proyecto.

5.3 Listar chats anteriores

Ejecuta esto en la terminal de tu sistema:

remy history list

Esto lista los chats del proyecto actual dentro del ámbito de tu cuenta activa. En la interfaz interactiva, usa /resume o Ctrl+R para elegir un chat y continuarlo.

Los chats que puedes ver dependen de la cuenta con la que has iniciado sesión, el ámbito del equipo y la carpeta del proyecto. Tener acceso al historial local no significa que todos los dispositivos se sincronicen automáticamente.

5.4 Ejecutar una tarea puntual

Para una tarea clara que no necesita una conversación continua, usa:

remy exec "Read this project’s README and summarize how to run the project and its tests. Analyze only; do not edit files."

El comando ejecuta esa tarea y muestra el resultado. Para trabajos que necesitan instrucciones de seguimiento, inicia el modo interactivo con remy.

Para proporcionar material de referencia local, adjunta un archivo:

remy exec --attach "./requirements.md" "Read these requirements and identify the affected modules and implementation steps in this project. Do not edit files yet."

Sustituye la ruta del archivo por un archivo que exista en tu equipo. Para ver más opciones, ejecuta:

remy exec --help

6. Actualizar Remy CLI

6.1 Comprobar tu versión

remy --version

6.2 Actualizar la versión predeterminada

Termina la tarea actual y sal de la interfaz interactiva de Remy; luego ejecuta:

npm install -g @corepassinc/remy

Cuando termine la instalación, vuelve a comprobarlo:

remy --version
remy --help

Si la CLI sigue mostrando una versión anterior, comprueba qué comando está encontrando tu terminal:

command -v remy
npm prefix -g

Si usas un gestor de versiones de Node.js, cada entorno de Node.js puede tener su propio directorio de instalación global. Después de cambiar de entorno, comprueba la instalación de Remy y la ruta del comando en el entorno activo.

7. Solución de problemas y limitaciones conocidas

7.1 Problemas de instalación y del entorno de ejecución

7.2 Alcance y limitaciones

• Esta guía cubre macOS en Apple silicon e Intel.
• Las tareas locales dependen de tu ordenador, tu sesión de terminal y el entorno de tu proyecto. Mantén disponible el entorno necesario.
• El acceso a herramientas varía según el cliente. Las herramientas opcionales de la CLI dependen de los resultados del diagnóstico y de la configuración real.
• Actualmente, la CLI no admite valoraciones de pulgar arriba/abajo para respuestas individuales. Usa el comando de comentarios de la siguiente sección para informar de problemas del producto.
• Retomar un chat no revierte los archivos. Comprueba el estado actual de los archivos antes de continuar.

8. Obtener ayuda y enviar comentarios

8.1 Ver la ayuda de los comandos

remy --help
remy doctor --help
remy feedback send --help

Dentro de Remy, usa /help para ver los comandos y Ctrl+G para ver los atajos de teclado.

8.2 Describir el problema

Guarda la descripción del problema en un archivo de texto UTF-8, como feedback.txt. Incluye los pasos para reproducirlo, lo que esperabas, lo que ocurrió y cualquier mensaje de error y dato de versión.

8.3 Previsualizar y enviar

Primero, previsualiza tu informe:

remy feedback send --type bug --impact moderate --description-file "./feedback.txt" --dry-run

--dry-run muestra la vista previa sin enviar ningún informe. Después de revisar la descripción y las opciones de comentarios, quita esa opción y vuelve a ejecutar el comando:

remy feedback send --type bug --impact moderate --description-file "./feedback.txt"

La CLI muestra una vista previa y luego te pide que escribas send para confirmar. Escribe cualquier otra cosa para cancelar.

Elige el tipo y el impacto que correspondan a tu problema; los valores bug y moderate del ejemplo son solo ejemplos.

Considera el informe enviado solo cuando el comando confirme explícitamente que se envió correctamente y devuelva un ID de comentario. Result unknown significa que la CLI no recibió un resultado de envío fiable. Consulta con el soporte antes de volver a enviarlo para evitar un informe duplicado.

Si no puedes iniciar la CLI, iniciar sesión o usar el comando de comentarios, contacta con el soporte en support@corepass.com.

8.4 Sigue explorando