cl-assistant 1.0.1

Command Line AI Assistant

CL-Assistant 🤖🖥️

CL-Assistant (Command Line Assistant) é um assistente de linha de comando movido por inteligência artificial, criado para te ajudar a gerar comandos de terminal com base em instruções em linguagem natural.

Com ele, você descreve o que deseja fazer, e o CL-Assistant retorna o comando exato para executar no seu terminal. Ideal para devs que valorizam agilidade e produtividade.

---

✨ Funcionalidades

• 💡 Sugere comandos de terminal a partir de descrições em linguagem natural
• 🖥️ Detecta automaticamente o sistema operacional e o seu diretório padrão para gerar comandos mais adequados
• 🌐 Possibilidade de simular comandos para outros sistemas operacionais com a flag --so
• 🔒 Usa uma API LLM (modelo de linguagem) configurável por variáveis de ambiente
• ⚡ Interface simples e direta via CLI
• 🧠 Powered by AI

---

📦 Instalação

Você pode instalar o pacote cl-assistant via pip:

pip install cl-assistant

O projeto se chama CL-Assistant, importa como cl-assistant e é usado no terminal com o comando cla.

---

🔑 Obtenha sua API Key gratuitamente

Para uso gratuito, acesse console.groq.com e obtenha sua API Key, base url e um model de algum modelo de sua preferência.

---

🔐 Configuração (Windows)

Antes de usar, defina três variáveis de ambiente:

• CLA_KEY: Sua chave de autenticação para a API.
• CLA_BASE_URL: URL base da API compatível com a OpenAI (ex: https://api.exemplo.com/v1)
• CLA_MODEL: URL base da API (ex: deepseek-chat, gpt-4o-mini, etc.)

Você pode definir as variáveis de ambiente diretamente no terminal (PowerShell ou CMD):

setx CLA_KEY "suachaveaqui"
setx CLA_BASE_URL "https://api.deepseek.com/v1"
setx CLA_MODEL "deepseek-chat"

⚠️ Após usar setx, feche e reabra o terminal para que as variáveis estejam disponíveis.

Se preferir, também pode definir as variáveis manualmente:

1. Abra o menu Iniciar e busque por "Variáveis de Ambiente"
2. Clique em "Variáveis de Ambiente"
3. Em "Variáveis de usuário", clique em "Novo..."
4. Crie as variáveis CLA_KEY, CLA_BASE_URL e CLA_MODEL com os valores apropriados

---

🔐 Configuração (Linux)

Antes de usar, defina três variáveis de ambiente:

• CLA_KEY: Sua chave de autenticação para a API
• CLA_BASE_URL: URL base da API compatível com a OpenAI (ex: https://api.exemplo.com/v1)
• CLA_MODEL: Modelo a ser utilizado (ex: deepseek-chat, gpt-4o-mini, etc.)

Exemplo no terminal:

export CLA_KEY=suachaveaqui
export CLA_BASE_URL=https://api.deepseek.com/v1
export CLA_MODEL=deepseek-chat

Ou adicione isso ao seu .bashrc, .zshrc ou arquivo .env.

🚀 Como usar

Comando básico

Descreva sua necessidade com uma frase:

cla "criar um ambiente virtual com Python"

E o CL-Assistant retorna:

python -m venv venv

---

🌍 Usando a flag --so

Por padrão, o CL-Assistant detecta automaticamente o sistema operacional (Windows, Linux ou macOS).
Se quiser que o comando seja gerado para um sistema diferente, use a flag --so.

cla "excluir arquivos temporários" --so windows

Resultado:

del *.tmp

Sistemas suportados:

• linux
• windows
• mac

---

🛠️ Exemplos adicionais

cla "listar todos os arquivos .log recursivamente"

find . -name "*.log"

cla "verificar o uso de memória" --so mac

vm_stat

---

🤖 Como funciona

O comando cla envia sua solicitação para uma API compatível com modelos de linguagem (LLM),
que interpreta sua instrução e retorna um comando de terminal correspondente em tempo real por streaming.

Você pode usar qualquer modelo de linguagem (LLM) compatível com a API da OpenAI — incluindo modelos locais, da própria OpenAI, ou de provedores equivalentes que sigam o mesmo formato de requisição.

---

🧪 Requisitos

• Python 3.9+
• Dependência principal: httpx

---

📄 Licença

MIT © Paulo Lira