From 28a8120f33627232ec898134d6d9ccc97a57a08e Mon Sep 17 00:00:00 2001 From: Micael Marques Date: Mon, 25 May 2026 19:45:25 -0300 Subject: [PATCH] docs(cli): documenta arara mode + simplifica install one-liner MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Destaca o `curl -fsSL https://get.ararahq.com/install-cli | sh` antes do CardGroup como instalação principal. Card Group passa a listar alternativas (PowerShell, Homebrew, Go install, download direto). - Nova seção "Modo LIVE vs TEST" explicando `arara mode live` / `arara mode test` e o avisor sobre `ACCOUNT_NOT_ACTIVATED`. - Adiciona `arara mode [live|test]` na tabela "Outros comandos". - Atualiza string de versão do exemplo `arara --version` pra refletir 0.1.0 e formato real ("arara version 0.1.0"). Depende de [ararahq/cli#3] (release v0.1.1). --- cli.mdx | 64 ++++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 52 insertions(+), 12 deletions(-) diff --git a/cli.mdx b/cli.mdx index cafbc72..57fb180 100644 --- a/cli.mdx +++ b/cli.mdx @@ -21,27 +21,32 @@ arara listen --forward-to http://localhost:3000/api/webhooks ## Instalação +**One-liner** — detecta OS + arquitetura, baixa o binário do GitHub Releases, valida checksum SHA-256 e instala em `/usr/local/bin` (ou `~/.local/bin` se não tiver sudo): + +```bash +curl -fsSL https://get.ararahq.com/install-cli | sh +``` + +Alternativas: + - - ```bash - brew install ararahq/tap/arara + + ```powershell + iwr -useb https://get.ararahq.com/install-cli.ps1 | iex ``` - + ```bash - curl -fsSL https://get.ararahq.com | sh + brew install ararahq/tap/arara ``` ```bash - go install github.com/ararahq/arara-cli/cmd/arara@latest + go install github.com/ararahq/cli/cmd/arara@latest ``` - - ```bash - npm install -g ararahq-cli - ``` - *baixa o binário Go correspondente no postinstall* + + [github.com/ararahq/cli/releases](https://github.com/ararahq/cli/releases) — tar.gz/zip por OS+arch + checksums.txt. @@ -49,7 +54,7 @@ Confere a versão: ```bash arara --version -# arara 0.2.0 (2026-05-12) +# arara version 0.1.0 ``` ## Login @@ -68,6 +73,40 @@ arara profile switch cliente-x arara profile list ``` +## Modo LIVE vs TEST + +Por default, depois do `arara login` o profile fica em **TEST** — `send` simula entrega, `campaigns` simula custo, nada chega no cliente real. + +Pra mandar mensagens reais, promove pra **LIVE**: + +```bash +arara mode live +``` + +A CLI cria uma API key LIVE server-side e guarda no keyring do SO. **O valor da chave nunca aparece na tela nem fica no shell history.** + +Pra voltar: + +```bash +arara mode test +arara login # restaura sessão OAuth +``` + +Confere o modo a qualquer momento: + +```bash +arara mode +# Profile default -- LIVE +``` + + + Em LIVE, **todo `send` cobra do saldo da wallet** e entrega de verdade. Em TEST, custo zero, entrega simulada. + + + + Pra criar chave LIVE a conta precisa estar `ACTIVE` (onboarding completo). Se vier `ACCOUNT_NOT_ACTIVATED`, complete o wizard em [ararahq.com/dashboard](https://ararahq.com/dashboard). + + ## Comandos principais ### `arara send` @@ -179,6 +218,7 @@ UUID local, batches de até 50 events em 5min, zero PII. | Comando | Função | |---|---| | `arara whoami` | Quem está logado, em qual org, qual modo da chave. | +| `arara mode [live\|test]` | Mostra ou troca o modo do profile sem expor chave. Ver [Modo LIVE vs TEST](#modo-live-vs-test). | | `arara doctor` | Diagnóstico: token válido, rede ok, latência, versão atualizada. | | `arara status` | Status público da Arara (igual `status.ararahq.com`). | | `arara campaigns list/get` | Lista e detalhe de campanhas. |