@hiperplano/aluy-cli 1.0.0-rc.180 → 1.0.0-rc.182

package/LICENSE

@@ -1,7 +1,21 @@
-Copyright (c) 2026 Hiperplano. Todos os direitos reservados.
+MIT License
 
-Aluy CLI. Este repositório é de visibilidade pública — o código é inspecionável —
-mas isto NÃO é uma concessão de licença de código aberto. Uso, cópia, modificação
-ou redistribuição fora da organização exigem autorização expressa por escrito.
+Copyright (c) 2026 Hiperplano
 
-Nenhuma credencial, chave de provider ou dado sensível mora neste repositório.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -5,110 +5,113 @@
   </picture>
 </p>
 
-<h1 align="center">Aluy CLI</h1>
+<p align="center">
+  <b>Um agente de terminal que roda na sua máquina, com a sua chave.</b><br>
+  Sem intermediário, sem metering, sem mandar o seu código para o servidor de ninguém.
+</p>
 
 <p align="center">
-  Um agente de terminal que roda na <b>sua máquina</b>, com o <b>seu próprio provider de LLM</b>.
+  <a href="https://www.npmjs.com/package/@hiperplano/aluy-cli"><img alt="npm" src="https://img.shields.io/npm/v/@hiperplano/aluy-cli?color=%23cc3534&label=npm"></a>
+  <a href="LICENSE"><img alt="Licença MIT" src="https://img.shields.io/badge/licen%C3%A7a-MIT-blue"></a>
+  <a href="https://github.com/hiperplano/aluy-cli/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/hiperplano/aluy-cli/actions/workflows/ci.yml/badge.svg?branch=main"></a>
+  <img alt="Node >= 20" src="https://img.shields.io/node/v/@hiperplano/aluy-cli">
+  <img alt="Linux · macOS · Windows" src="https://img.shields.io/badge/-Linux%20%C2%B7%20macOS%20%C2%B7%20Windows-informational">
 </p>
 
 ---
 
-O **Aluy CLI** é um agente de terminal: ele lê e edita arquivos, executa
-comandos, busca no seu código e conduz seu próprio **loop de ferramentas** — tudo
-numa TUI rica, com uma **engine de permissão** onde todo efeito passa por uma
-catraca antes de acontecer.
-
-Você usa o **seu próprio modelo** (BYO): qualquer provider compatível com a API da
-OpenAI, com a sua própria credencial — direto, sem intermediário e sem metering.
-_(Por enquanto o aluy roda só local, com a sua chave.)_
-
-## Instalação
-
 ```bash
 npm install -g @hiperplano/aluy-cli
-aluy onboard      # configura idioma, provider, modelo e (opcional) os complementos
+aluy onboard      # instalador guiado: idioma, provider, modelo
 aluy              # abre a sessão
 ```
 
-O `aluy onboard` é o instalador guiado: escolhe o idioma, conecta o seu provider
-(faz um teste de conectividade real antes de prosseguir), e oferece os complementos
-opcionais. Funciona em **Linux, macOS e Windows** — o terminal recomendado é o
-[WezTerm](https://wezterm.org), mas qualquer terminal moderno serve.
-
-## Uso
+O **Aluy CLI** lê e edita arquivos, executa comandos, busca no seu código e conduz
+o próprio loop de ferramentas numa TUI rica. Você aponta o objetivo; ele trabalha.
 
 ```bash
-aluy                          # sessão interativa (TUI)
-aluy "refatore o módulo X"    # dá um objetivo direto e acompanha o agente trabalhar
-aluy -p "liste os TODOs"      # modo headless (one-shot), ideal p/ scripts/CI
-aluy --resume <id|nome>       # retoma uma conversa anterior (id ao sair, ou o nome do /rename)
-aluy --continue               # retoma a sessão mais recente deste diretório
+aluy "migre os testes de jest para vitest"   # um objetivo, e acompanhe
+aluy -p "liste os TODOs" --output-format json # headless, para script e CI
+aluy --plan "como eu quebraria esse módulo?"  # só lê e analisa, zero efeito
+aluy --continue                               # retoma de onde parou
 ```
 
-Dentro da sessão, **slash-commands** controlam tudo sem sair do fluxo:
+## Por que este, e não outro
 
-| Comando                                       | O que faz                                          |
-| --------------------------------------------- | -------------------------------------------------- |
-| `/model` · `/provider` · `/effort`            | troca modelo / provider / esforço de raciocínio    |
-| `/init`                                       | cria o `ALUY.md` + a estrutura `.aluy/` do projeto |
-| `/mcp` · `/agents` · `/skills` · `/workflows` | gerencia MCP, sub-agentes, skills e workflows      |
-| `/rooms`                                      | salas de conversa entre agentes (multi-agente)     |
-| `/rename` · `/theme` · `/lang`                | nome+cor da sessão, tema, idioma                   |
-| `/memory` · `/compact` · `/history`           | memória, compactação de contexto, histórico        |
+**A chave é sua, e o caminho é direto.** Nove providers no catálogo — Anthropic,
+OpenAI, OpenRouter, Google, DeepSeek, Groq, Mistral, xAI e Ollama — ou qualquer
+endpoint compatível com a API da OpenAI. Não há servidor nosso no meio: o seu
+código e o seu prompt vão do seu terminal para o provider que **você** escolheu.
+A credencial nunca fica em claro — vai para o keychain do SO ou, onde ele não
+existe, para um cofre cifrado que não funciona em outra máquina.
 
-## Como funciona
+**Uma catraca, e só uma.** Todo tool-call passa por um ponto único de
+interceptação antes de virar efeito, com negação por padrão. Não é uma convenção:
+é uma fronteira travada no lint e coberta por teste, e a engine que a hospeda não
+pode nem importar a TUI. Quando você quiser velocidade em vez de perguntas, o
+`--yolo` existe; quando quiser o contrário, o `--plan` deixa tudo read-only.
 
-- **Agente + permissão** — o loop de ferramentas (ler/editar/rodar/buscar) passa por
-  um ponto único de interceptação: nada com efeito acontece sem a catraca liberar
-  (ou você aprovar). O modo `--yolo` dispensa as confirmações por sua conta e risco.
-- **BYO provider** — `--backend local` fala direto com o provider (API key ou OAuth).
-  A credencial fica **só no keychain do SO** (macOS Keychain · Windows Credential
-  Manager · Linux Secret Service) — nunca em arquivo, `.env` ou log.
-- **MCP** — conecta servers MCP (`~/.aluy/mcp.json` global e `.mcp.json` do projeto),
-  compatível com o ecossistema; o onboard ainda oferece pré-instalar alguns (Playwright,
-  Filesystem, Memory, …).
-- **Complementos opcionais** (modo turbo) — memória persistente, modelos locais via
-  Ollama e gestão de contexto, instaláveis no onboard ou depois com `aluy bootstrap`.
-  Guia completo (instalação, problemas comuns, instalação manual): [docs/turbo.md](docs/turbo.md).
+**O trabalho continua sem você.** Um serviço é um diretório com um `service.md`:
+horário, orçamento, autonomia e canal. Ele acorda sozinho, abre um turno, respeita
+o teto de tokens — e, quando precisa de uma decisão que não é dele, **pergunta pelo
+Telegram e espera**, em vez de chutar. Você responde do celular e ele retoma.
 
-## Configuração
+**Fala com o resto do ecossistema.** Servers MCP (globais e por projeto), sub-agentes
+em `.md`, skills, workflows, hooks e plugins. E ele lê o `AGENTS.md` e o `CLAUDE.md`
+do seu repositório junto com o `ALUY.md` — eles compõem, não competem, então adotar
+o aluy não obriga a reescrever o que você já tem.
 
-Tudo vive em `~/.aluy/`:
+## Documentação
 
-| Arquivo          | Conteúdo                                                       |
-| ---------------- | -------------------------------------------------------------- |
-| `config.json`    | preferências (idioma, tema, provider/modelo, perfil, limites…) |
-| `providers.json` | seus providers BYO (OpenAI-compatíveis)                        |
-| `mcp.json`       | servers MCP globais                                            |
+| | |
+| --- | --- |
+| [Comandos](docs/comandos.md) | subcomandos, flags e os 46 slash-commands |
+| [Configuração](docs/configuracao.md) | `~/.aluy/`, precedência, hooks, arquivos de projeto |
+| [Serviços](docs/comandos.md#serviços) | o `service.md` e o runner contínuo |
+| [MCP](docs/mcp.md) | conectar servers, e o que isso implica |
+| [Modo turbo](docs/turbo.md) | memória persistente, Ollama, gestão de contexto |
+| [Compatibilidade](docs/config-compat.md) | conviver com a config de outros agentes |
 
-Variáveis `ALUY_*` e flags de CLI sobrescrevem (precedência **flag > env > config > default**).
-No **projeto**, o `ALUY.md` dá as instruções ao agente e `.aluy/` guarda agents, workflows,
-commands e skills.
+`aluy --help` traz tudo isso no terminal, e `aluy doctor` diz o que está quebrado
+e como consertar.
 
-## Monorepo
+## Segurança
 
-| Pacote                          | Papel                                                                                                                                         |
-| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`@hiperplano/aluy-cli-core`** | Engine **portável** do agente (loop · tools · permissão). Sem Ink, sem I/O de terminal. Hospeda o ponto único de interceptação de tool-calls. |
-| **`@hiperplano/aluy-cli`**      | TUI (**Ink**) + binário **`aluy`** + wiring. Consome `@hiperplano/aluy-cli-core`.                                                             |
+O aluy roda **na sua máquina, com os seus privilégios**. Três coisas que vale saber
+antes de usar:
 
-Lema: **core modular, entrega monolítica**. A fronteira `core × TUI` é explícita e
-testada (o core não importa Ink).
+- Um **server MCP** de terceiro roda com os seus privilégios e **sem sandbox** — ele
+  pode ler o seu filesystem. Plugue só os que você confia.
+- O **`--yolo`** aprova tudo automaticamente. É útil e é perigoso; a escolha é sua.
+- Credencial **nunca** vai para arquivo em claro, log ou `.env`, e o `gitleaks` roda
+  na CI para garantir que nenhuma vaze para o repositório.
 
-### Desenvolvimento
+Encontrou uma vulnerabilidade? Abra uma
+[issue](https://github.com/hiperplano/aluy-cli/issues) marcando como sensível, ou
+fale com os mantenedores antes de divulgar.
+
+## Contribuir
+
+PRs são bem-vindos. O [CONTRIBUTING.md](CONTRIBUTING.md) tem o essencial:
 
 ```bash
-npm install
-npm run build       # tsc -b (cli-core → cli)
-npm run lint
+git clone https://github.com/hiperplano/aluy-cli && cd aluy-cli
+npm install && npm run build
 npm test
-node packages/cli/dist/bin/aluy.js --help
 ```
 
-## Contribuir
+Duas regras que não relaxamos: **a CI é honesta** (nada de `|| true` ou
+`continue-on-error` — gate vermelho bloqueia o merge) e **a fronteira do core é
+real** (`@hiperplano/aluy-cli-core` não importa Ink nem faz I/O de terminal,
+travado no eslint e em teste).
+
+O histórico de cada versão está no [CHANGELOG.md](CHANGELOG.md).
+
+## Estado
 
-Ver [`CONTRIBUTING.md`](CONTRIBUTING.md).
+`1.0.0-rc` — em uso diário, com release frequente. A superfície de comandos está
+estável; o que ainda muda vem anotado no CHANGELOG a cada rc.
 
 ## Licença
 
-Ver [`LICENSE`](LICENSE).
+[MIT](LICENSE) © Hiperplano