Instalação e uso da CLI

Este guia abrange a instalação da CLI do Remy no macOS, o login, a execução de tarefas em projetos locais, a retomada de conversas, a atualização da CLI e o envio de feedback.

flowchart LR
    A["Set up Node.js and npm"] --> B["Install Remy CLI"]
    B --> C["Sign in"]
    C --> D["Go to your project"]
    D --> E["Start a task"]
    E --> F["Review and continue"]

1. Antes de começar

1.1 Requisitos de sistema e ambiente de execução

A CLI exige Node.js e npm. A instalação padrão da CLI do Remy pelo npm não exige uma instalação separada de Python ou Rust. Seu projeto e seus testes ainda precisam do próprio ambiente e das próprias dependências.

Confira sua configuração no terminal:

node --version
npm --version

Os dois comandos devem imprimir um número de versão. Se algum comando não for encontrado, obtenha o instalador adequado para Mac no site do Node.js, conclua a instalação e abra um novo terminal. Escolha a versão LTS atual antes de instalar o Remy.

1.2 Acesso a modelos

Entre com sua conta do Remy para usar os modelos disponíveis nela. O fluxo padrão não exige uma conta separada de provedor de modelos nem uma chave de API.

Entre no aplicativo desktop e na CLI separadamente. Mesmo que já esteja conectado ao Remy Desktop, você ainda precisa entrar na primeira vez que usar a CLI.

2. Instale e confira a CLI

2.1 Instale a CLI do Remy

Execute isto no terminal:

npm install -g @corepassinc/remy

Aguarde a instalação terminar. O instalador seleciona os componentes para seu sistema operacional e a arquitetura do ambiente de execução do Node.js. Você não precisa escolher um pacote separado da CLI para Apple silicon ou Intel.

2.2 Confira se o comando está disponível

Depois de instalar, execute:

remy --version
remy --help

Se o terminal não encontrar remy, abra um novo terminal e consulte as orientações sobre instalação e caminho de comandos na seção 7.

3. Entre e confira sua conta

3.1 Entre na sua conta

Execute isto no terminal:

remy login

1. Conclua o login no navegador que abrir.
2. Volte ao terminal e aguarde o resultado.
3. Quando vir Conectado como …, continue para a próxima etapa.

Se o login falhar, siga a mensagem do terminal para conferir a conexão ou iniciar o login novamente.

3.2 Confira a conta ativa

remy whoami

Use este comando para conferir a conta conectada, seu escopo atual de conta e o diretório de trabalho. Se usar uma conta de equipe, confirme que a equipe pretendida está selecionada.

3.3 Confira o ambiente de execução

remy doctor

Use os resultados para decidir o que precisa de atenção:

Passar nas verificações do ambiente de execução não valida uma tarefa completa. Execute uma tarefa real para confirmar que o acesso aos modelos, o acesso ao projeto e os resultados funcionam como esperado.

Para sair da CLI:

remy logout

4. Inicie uma tarefa interativa no seu projeto

4.1 Vá à pasta do projeto

No terminal, vá ao projeto em que deseja trabalhar e inicie o Remy:

cd "/path/to/project"
remy

Substitua /path/to/project pelo caminho local real do seu projeto.

Você também pode especificar a pasta do projeto ao iniciar o Remy:

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

Confira a pasta antes de começar. A CLI trabalha a partir do diretório de trabalho atual. Para trabalhar em outro projeto, saia da sessão interativa e vá à outra pasta ou inicie o Remy com --workspace.

4.2 Escolha um modelo e envie uma tarefa

Na interface interativa do Remy:

1. Pressione F2 ou digite /model para ver os modelos disponíveis.
2. Escolha um modelo. Para modelos com configurações de raciocínio, use Ctrl+U para ajustá-las.
3. Descreva sua tarefa na área de entrada e pressione Enter para enviá-la.

Em um terminal macOS, Option+Enter adiciona uma nova linha. Pressione Ctrl+G para ver os atalhos de teclado e as opções disponíveis.

Escolha um modelo antes de iniciar a tarefa. A lista exibida na CLI reflete os modelos disponíveis para sua conta atual.

4.3 Faça uma pequena alteração

Escolha um problema real em um projeto existente. O exemplo abaixo usa filtragem e paginação em uma lista de pedidos; adapte o recurso e o comportamento ao seu próprio projeto.

Primeiro, entenda o código relevante:

Leia a documentação deste projeto e as instruções relevantes.
Identifique os arquivos, a lógica de filtragem, a lógica de paginação e os testes da lista de pedidos.

Apenas analise. Não edite arquivos, instale dependências, faça commits nem envie código.

Depois de conferir se o Remy entendeu a tarefa, continue na mesma conversa:

Quando altero o filtro de status na página 3 da lista de pedidos, a lista parece vazia.
Os resultados só aparecem depois que volto à página 1.

Encontre e corrija o problema para que a alteração do filtro redefina o número da página.
Altere somente a lógica relevante e adicione e execute os testes relevantes.
Ao terminar, resuma os arquivos alterados, os resultados das verificações e quaisquer verificações que não conseguiu concluir.

Ainda não faça commits nem envie código.

Se o Remy pedir mais informações ou confirmação, leia a solicitação antes de responder. Use /permissions para ver as permissões de ação da conversa atual e siga as instruções da interface para escolher uma configuração.

4.4 Revise os resultados e continue

Se o projeto usa Git, abra outra janela de terminal no mesmo projeto para inspecionar as alterações sem commit:

git status --short
git diff

Por padrão, git diff mostra alterações não preparadas para commit em arquivos rastreados. Ele não mostra o conteúdo de arquivos novos nem alterações preparadas para commit. Use git diff --cached para as alterações preparadas e abra diretamente os arquivos novos para inspecioná-los. As alterações exibidas também podem incluir trabalho que existia antes do início da tarefa.

Para refinar o resultado, descreva o que aconteceu, o que você esperava e o que deve mudar na conversa original:

O número da página agora é redefinido, mas a lista não é atualizada.
Ela deve solicitar dados novos assim que o filtro mudar.

Corrija somente esse problema, adicione e execute os testes relevantes
e resuma a alteração e os resultados das verificações. Ainda não faça commits nem envie código.

4.5 Atalhos de teclado comuns

5. Comandos e continuação de conversas

5.1 Saiba onde digitar um comando

Execute comandos de instalação como npm install no terminal do sistema, em vez de enviá-los ao Remy como prompts de tarefa.

5.2 Comandos interativos comuns

Antes de iniciar uma nova conversa ou retomar uma existente, conclua a tarefa atual e confira os arquivos como eles realmente estão no projeto.

5.3 Liste conversas anteriores

Execute isto no terminal do sistema:

remy history list

Isso lista as conversas do projeto atual dentro do escopo da conta ativa. Na interface interativa, use /resume ou Ctrl+R para escolher uma conversa e continuá-la.

As conversas que você pode ver dependem da conta conectada, do escopo da equipe e da pasta do projeto. O acesso ao histórico local não significa que todos os dispositivos são sincronizados automaticamente.

5.4 Execute uma tarefa única

Para uma tarefa clara que não precise de uma conversa contínua, use:

remy exec "Leia o README deste projeto e resuma como executar o projeto e seus testes. Apenas analise; não edite arquivos."

O comando executa essa tarefa e imprime o resultado. Para trabalhos que precisam de instruções de acompanhamento, inicie o modo interativo com remy.

Para fornecer material de referência local, anexe um arquivo:

remy exec --attach "./requirements.md" "Leia estes requisitos e identifique os módulos afetados e as etapas de implementação neste projeto. Ainda não edite arquivos."

Substitua o caminho por um arquivo que exista no seu computador. Para mais opções, execute:

remy exec --help

6. Atualize a CLI do Remy

6.1 Confira sua versão

remy --version

6.2 Atualize a versão padrão

Conclua a tarefa atual e saia da interface interativa do Remy. Em seguida, execute:

npm install -g @corepassinc/remy

Quando a instalação terminar, confira novamente:

remy --version
remy --help

Se a CLI ainda informar uma versão antiga, confira qual comando o terminal está encontrando:

command -v remy
npm prefix -g

Se você usa um gerenciador de versões do Node.js, cada ambiente Node.js pode ter seu próprio diretório de instalação global. Depois de trocar de ambiente, confira a instalação do Remy e o caminho do comando no ambiente ativo.

7. Solução de problemas e limitações conhecidas

7.1 Problemas de instalação e ambiente de execução

7.2 Escopo e limitações

• Este guia abrange o macOS em Apple silicon e Intel.
• As tarefas locais dependem do computador, da sessão de terminal e do ambiente do projeto. Mantenha o ambiente necessário disponível.
• O acesso às ferramentas varia entre clientes. As ferramentas opcionais da CLI dependem dos resultados do diagnóstico e da configuração real.
• A CLI atualmente não oferece avaliações de gostei/não gostei para respostas individuais. Use o comando de feedback da próxima seção para problemas do produto.
• Retomar uma conversa não reverte arquivos. Confira o estado atual dos arquivos antes de continuar.

8. Obtenha ajuda e envie feedback

8.1 Consulte a ajuda dos comandos

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

Dentro do Remy, use /help para os comandos e Ctrl+G para os atalhos de teclado.

8.2 Descreva o problema

Salve a descrição do problema em um arquivo de texto UTF-8, como feedback.txt. Inclua os passos para reproduzi-lo, o que você esperava, o que aconteceu e quaisquer mensagens de erro e detalhes da versão.

8.3 Visualize e envie

Visualize seu relato primeiro:

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

--dry-run mostra a prévia sem enviar um relato. Depois de conferir a descrição e as opções de feedback, remova essa flag e execute o comando novamente:

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

A CLI mostra uma prévia e pede que você digite send para confirmar. Digite outra coisa para cancelar.

Escolha o tipo e o impacto que correspondem ao seu problema; os valores bug e moderate do exemplo são apenas exemplos.

Considere o relato enviado somente quando o comando confirmar explicitamente o sucesso e retornar um ID de feedback. Resultado desconhecido significa que a CLI não recebeu um resultado confiável do envio. Consulte o suporte antes de enviar novamente para evitar um relato duplicado.

Se não conseguir iniciar a CLI, entrar na conta ou usar o comando de feedback, entre em contato com o suporte em support@corepass.com.

8.4 Continue explorando