Zev: uma ferramenta CLI para consulta rápida de comandos de terminal em linguagem natural

Introdução geral

O Zev é uma ferramenta de interface de linha de comando (CLI) fácil de usar que ajuda os usuários a consultar e gerar rapidamente comandos de terminal em linguagem natural. Em vez de memorizar a sintaxe de comandos complexos, o Zev gera comandos de terminal descrevendo os requisitos em linguagem cotidiana. Com base na API OpenAI ou nativa Ollama O modelo Zev suporta uma variedade de cenários operacionais, como gerenciamento de arquivos, visualização de processos, inspeção de rede e operações do Git. O Zev foi projetado para reduzir o limite de uso da linha de comando, adequado para desenvolvedores e novatos. Os usuários precisam configurar uma chave de API OpenAI ou um ambiente Ollama local para usá-lo. O código do zev é de código aberto no GitHub, permitindo que os usuários contribuam livremente e o personalizem.

Lista de funções

• Gerar comandos de terminal em linguagem natural, por exemplo, "show current directory disk usage".
• Suporta uma variedade de cenários operacionais, incluindo manipulação de arquivos, gerenciamento de processos, inspeção de rede e comandos Git.
• Integração com a API OpenAI para fornecer geração inteligente de comandos.
• Oferece suporte a modelos nativos do Ollama e permite a operação off-line.
• Fornece a função de gerenciamento de chaves de API para que os usuários atualizem as configurações.
• Código-fonte aberto, suporte para contribuições da comunidade e extensões de recursos.

Usando a Ajuda

Processo de instalação

O Zev é uma ferramenta CLI desenvolvida em Python com um processo simples de instalação e configuração. Veja a seguir as etapas detalhadas:

1. armazém de clones
   Abra um terminal e execute o seguinte comando para clonar o repositório do Zev no GitHub:

   git clone https://github.com/dtnewman/zev.git

Quando a clonagem estiver concluída, vá para o diretório do projeto:

cd zev

2. Instalação de dependências
   O Zev depende de um ambiente Python 3.6+. Certifique-se de que o Python esteja instalado e, em seguida, instale as dependências necessárias:

   pip install -r requirements.txt
   

   As dependências incluem as bibliotecas de cliente Python da OpenAI, que podem ser encontradas no diretório requirements.txt Veja em.

3. Configuração das chaves da API da OpenAI
   Na primeira vez que você executar o Zev, será solicitada uma chave de API da OpenAI. Os usuários precisam registrar uma conta no site da OpenAI e criar uma chave. Execute o seguinte comando para iniciar a configuração:

   python zev.py
   

   Digite a chave conforme solicitado e ela será salva no arquivo de configuração local.
   Se você precisar atualizar a chave, execute:

   zev --update-key
   

4. (Opcional) Configuração do modelo Ollama
   Se quiser executar o Zev localmente, você pode instalar o Ollama e configurar um modelo local:
   • Visite o site da Ollama para fazer o download e instalar o Ollama.
   • Inicie o serviço Ollama e selecione o modelo, por exemplo:

     ollama run llama3
     

   • Habilite o modo Ollama na configuração do Zev, execute:

     zev --use-ollama
     

   Isso permitirá que o Zev use um modelo local, que é adequado para usuários sem um ambiente de rede ou que se preocupam com a privacidade.

5. Executar Zev
   Após a conclusão da instalação e da configuração, execute o seguinte comando para iniciar o Zev:

   python zev.py
   

Funções principais

A principal função do Zev é gerar comandos de terminal por meio de linguagem natural. Veja como ele funciona:

• Comandos do terminal de consulta
  No terminal, digite zev seguido de uma descrição em linguagem natural. Por exemplo, para ver todos os processos Python em execução:

  zev 'show all running python processes'
  

  Zev retorna algo como ps aux | grep python comandos. O usuário pode copiar a execução diretamente.

• operação de arquivo
  Localize arquivos modificados recentemente, por exemplo:

  zev 'find all .py files modified in the last 24 hours'
  

  O comando de saída pode ser:

  find . -type f -name "*.py" -mtime -1
  

• Consulta de informações do sistema
  Visualizar o uso do disco:

  zev 'show disk usage for current directory'
  

  Comandos de saída, como:

  du -sh .
  

• verificação de rede
  Teste a conectividade da rede, por exemplo:

  zev 'check if google.com is reachable'
  

  O comando de saída pode ser:

  ping -c 4 google.com
  

• Operações do Git
  Exibir alterações não confirmadas no Git:

  zev 'show uncommitted changes in git'
  

  Comandos de saída, como:

  git status
  

Operação da função em destaque

• Suporte local ao modelo Ollama
  A execução do Zev com o Ollama é totalmente off-line e protege a privacidade dos dados. Depois de configurado, o Zev chama automaticamente o modelo local para gerar comandos sem a necessidade de uma conexão com a Internet.
  Exemplo:

  zev --use-ollama 'list all files in current directory'
  

  Comando de saída:

  ls -la
  

• Gerenciamento de chaves de API
  Os usuários podem atualizar sua chave OpenAI ou trocar de modelo a qualquer momento. Executar:

  zev --update-key
  

  Digite a nova chave conforme solicitado e a configuração entrará em vigor imediatamente.

Precauções de manuseio

• Certifique-se de que sua rede esteja estável para usar a API OpenAI. Se estiver usando o Ollama, será necessário iniciar o serviço de modelo com antecedência.
• A descrição da linguagem natural da entrada é tão clara e específica quanto possível para evitar ambiguidade. Por exemplo, "listar arquivos" pode gerar lse "List all hidden files" gera a opção ls -a.
• Os comandos gerados pelo Zev são apenas para referência, e é recomendável verificar se os comandos atendem às expectativas antes de executá-los.

Uso avançado

• Geração de comandos personalizados
  Os usuários podem bifurcar o repositório do Zev no GitHub para modificar o código e dar suporte a cenários específicos. Por exemplo, para adicionar modelos de comando personalizados ou para oferecer suporte a outros modelos de IA.
• operação em lote
  No momento, o Zev não oferece suporte à geração de comandos em lote, mas os usuários podem invocar o Zev por meio de scripts, por exemplo, escrevendo um script de shell para percorrer o zev para lidar com várias tarefas.

cenário do aplicativo

1. Ambiente de depuração do desenvolvedor
   Para os desenvolvedores que usam com frequência comandos de terminal ao depurar códigos, como verificar o status de um processo ou de um arquivo, o Zev economiza tempo ao permitir que os comandos sejam gerados rapidamente em linguagem natural. Por exemplo, se você digitar "find processes on port 8080", o Zev gera o seguinte comando lsof -i :8080.
2. Aprendendo a linha de comando como um novato
   Os recém-chegados à linha de comando geralmente ficam frustrados com a incapacidade de se lembrar da sintaxe complexa, por isso o Zev reduz as barreiras ao aprendizado por meio da entrada de linguagem natural. Por exemplo, digite "show all file sizes in current folder" e o Zev gerará ls -lhajudando os usuários a se familiarizarem rapidamente.
3. Manutenção diária para administradores de sistema
   Para os administradores de sistema que precisam verificar o status de um servidor ou realizar diagnósticos de rede, o Zev oferece suporte à geração rápida de comandos como "check disk space" para gerar um comando "check disk space". df -hpara melhorar a eficiência.

QA

1. Quais sistemas operacionais são compatíveis com o Zev?
   O Zev é compatível com macOS, Linux e Windows (é necessário um ambiente Python). Alguns comandos podem precisar ser ajustados manualmente devido a diferenças de sistema.
2. Tenho que usar a API da OpenAI?
   Não é necessário. O Zev oferece suporte a modelos locais do Ollama para aqueles que os utilizam off-line ou não querem depender de serviços em nuvem.
3. Como faço para contribuir com o código?
   entrevistas https://github.com/dtnewman/zevPara obter mais informações sobre como contribuir com o repositório, consulte a seção CONTRIBUTING.md.
4. Os comandos gerados pelo Zev são seguros?
   Os comandos gerados pelo Zev são baseados na entrada do usuário e no raciocínio do modelo. Recomenda-se verificar o conteúdo dos comandos antes da execução para evitar possíveis riscos.