Get Started

Instalação

Nenhuma dependência externa, sem requerimentos pesados. Basta ter Node.js 18+.

Via npx (recomendado)

npx ryuki

Instala e roda na hora, sem precisar de config global.

Instalação Global

npm install -g ryuki
ryuki

Setup (Primeiras Chaves)

Na primeira execução, o Ryuki pede duas chaves gratuitas. Leva 1 minuto:

1. Firecrawl API Key

  1. 👉 Acesse firecrawl.dev
  2. 📝 Crie conta (grátis)
  3. 🔑 Copie a API Key no dashboard
  4. 💾 Cola no prompt do Ryuki

2. Groq API Key

  1. 👉 Acesse console.groq.com
  2. 📝 Crie conta (grátis, 100k tokens/dia)
  3. 🔑 Copie a API Key
  4. 💾 Cola no prompt do Ryuki

As chaves são salvas em ~/.config/ryuki/config.json (arquivo protegido, só pra você).

Uso

One-shot (direto)

ryuki "quem ganhou a copa do mundo 2022?"

Busca, responde e sai. Sem abrir o modo interativo.

Modo Interativo

ryuki

Abre o REPL. Pergunta tudo que quiser:

ryuki> qual é a capital da França?
A capital da França é Paris [1]...
ryuki> /set detail=short
ryuki> qual a população?
~2.2 milhões [1]

Modo Rápido

ryuki --fast "Python é melhor que JavaScript?"

Usa modelo mais compacto (mais rápido, menos tokens).

Comandos

No modo interativo, comandos começam com /. Pressione / pra ver o menu.

/model
Escolhe entre kunai (rápido) ou gear (completo)
/set detail=short|full
Modo detalhado: short = resumido, full = completo (padrão)
/export markdown | /export json
Salva última resposta em ~/.config/ryuki/exports/
/search termo
Busca no histórico de conversas
/set temperature=0.3
Ajusta criatividade (0-1)
/config
Mostra configurações
/help
Lista de comandos

Próximos Passos

📦 Releases

Veja todas as versões e novidades

🔧 GitHub

Código-fonte, issues e contribute