Skip to content

JairRodrigue/Brain-CLI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🧠 BRAIN CLI - Personal Assistant

Seu assistente de terminal híbrido: Inteligência Artificial (Groq) + Memória Local + Automação.
Disponível para Windows, Linux e macOS (qualquer sistema com Python e Bash).

Brain CLI

O Brain CLI é uma ferramenta de linha de comando escrita em Python que ajuda desenvolvedores a lembrar, gerar e entender comandos de terminal (Linux / Git / Docker) de forma instantânea.


🎯 Escolha como você quer usar

  • 👉 Quero usar no terminal, sem mexer no código → Instalação rápida (pip)
  • 👉 Quero estudar, modificar ou contribuir com o código → Instalação para desenvolvimento (GitHub)

🔧 Pré-requisitos

Certifique-se de ter o Python instalado. Se não tiver o pip:

  • Linux / macOS
sudo apt install python3-pip

📦 Instalação Rápida (Recomendado para uso)

Ideal se você só quer usar o Brain CLI no terminal, como qualquer outra ferramenta.

pip install brain-cli

Após instalar, teste:

brain info

🧪 Instalação para Desenvolvimento (GitHub)

Use esta opção se você quiser experimentar, estudar ou modificar o código.

1️⃣ Clone o repositório:

git clone https://github.com/JairRodrigue/Brain-CLI.git
cd Brain-CLI

2️⃣ Crie um ambiente virtual e instale as dependências:

python3 -m venv venv
source venv/bin/activate  # No Windows: venv\Scripts\activate
pip install -r requirements.txt

3️⃣ Execute localmente:

brain info

✨ Funcionalidades

  • 🤖 IA Generativa: Usa a API da Groq (Llama 3) para gerar comandos a partir de linguagem natural.
  • 💾 Memória Local: Salva comandos úteis em um banco SQLite local.
  • 🚀 Modo Automação: Gera e executa comandos automaticamente (-r).
  • 🧐 Professor Linux: Explica detalhadamente qualquer comando.
  • 📋 Clipboard: Copia automaticamente o comando gerado.

🚀 Comandos Disponíveis

Comando Descrição Exemplo
brain config Configura a chave da IA brain config gsk_SUA_CHAVE_AQUI
brain ask "texto" Pergunta à IA ou busca local brain ask "como desfazer commit"
brain ask ... -r Executa o comando gerado brain ask "listar pastas" -r
brain add Salva um comando manualmente brain add "git s" "git status"
brain explain Explica um comando brain explain "chmod 777 app"
brain list Lista comandos salvos brain list
brain info Ajuda e versão brain info

Nota: Para usar a IA do sistema, é obrigatório configurar a chave da API antes usando o comando brain config.


📦 Backup e Restauração

brain export backup.json
brain import backup.json

🛡 Tecnologias

  • Typer
  • Rich
  • Groq SDK
  • SQLite

🔐 Variáveis de Ambiente

Para usar os recursos de IA:

export GROQ_API_KEY="sua_chave_aqui"

⚠️ Nunca coloque sua API Key diretamente no código.


📄 Licença

Este projeto está sob a licença MIT.
Sinta-se livre para usar, estudar, modificar e contribuir.

About

Transforme linguagem natural em comandos de terminal com IA e memória local.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages