Sendmux CLI
Sendmux CLI é uma ferramenta de interface de linha de comando projetada para fornecer acesso ao terminal às superfícies de Gerenciamento, Mailbox e API de Envio da Sendmux. Ela permite que os usuários gerenciem fluxos de trabalho de email, incluindo operações de caixa de entrada e envio de emails, diretamente do terminal. Essa ferramenta é ideal para desenvolvedores e administradores de sistemas que preferem trabalhar em um ambiente de linha de comando e desejam integrar os serviços de email da Sendmux em seus fluxos de trabalho de forma eficiente.
O CLI suporta chaves API escopadas, distinguindo entre chaves escopadas para caixas de correio e comandos de envio, e chaves escopadas para gerenciamento de equipes. Essa separação garante um controle de acesso seguro e adequado para diferentes operações. Os usuários podem instalar o CLI via Homebrew no macOS ou Linux, ou através do npm, tornando-o acessível em diversos ambientes de desenvolvimento.
Perfis podem ser configurados localmente para armazenar as chaves API de forma segura, evitando a necessidade de passar as chaves a cada comando. O CLI também suporta a substituição das URLs base da API por comando ou sessão, fornecendo flexibilidade para diferentes cenários de implantação ou ambientes de teste.
Os comandos são estruturados com nomes separados por dois pontos e suportam passar corpos de requisição inline ou a partir de arquivos. O CLI valida os valores digitados antes de enviar as requisições e rejeita parâmetros não suportados, ajudando os usuários a evitar erros. A saída pode ser formatada para facilitar a leitura ou a análise automatizada, suportando integração com outras ferramentas.
Flags de segurança de requisição, como chaves de idempotência e cabeçalhos condicionais, são suportados para ajudar na gestão da segurança e concorrência das requisições. O conjunto de comandos do CLI é gerado a partir das superfícies da API pública, garantindo consistência e funcionalidade atualizada. Documentação abrangente e guias estão disponíveis para ajudar os usuários na instalação, configuração e uso.
Em geral, o Sendmux CLI oferece uma maneira poderosa e flexível de interagir com os serviços de gerenciamento e envio de email da Sendmux diretamente do terminal, atendendo a desenvolvedores e equipes que necessitam de fluxos de trabalho de email automatizados e scriptáveis.
📥 Gerencie caixas de correio e envio de e-mails pelo terminal para controle rápido
🔑 Use chaves API com escopo para proteger comandos de caixa de correio e gerenciamento
⚙️ Configure perfis localmente para evitar passar chaves a cada vez
📄 Envie corpos de requisição inline ou por arquivos para entrada flexível
🔍 Gere saída em JSON ou texto formatado para leitura fácil ou automação
Suporta chaves de API com escopo para controle de acesso seguro
Instalação fácil via Homebrew ou npm
Gerenciamento local de perfil para conveniência e segurança
Valida parâmetros de comando para reduzir erros
Suporta idempotência e cabeçalhos de requisição condicionais
Requer familiaridade com interfaces de linha de comando
Nenhuma interface gráfica disponível
Limitado à funcionalidade exposta pelas APIs Sendmux
Como instalo o Sendmux CLI?
Você pode instalar o Sendmux CLI usando o Homebrew no macOS ou Linux com brew install sendmux/tap/sendmux, ou via npm com npm install -g @sendmux/cli.
Como configuro as chaves API para o CLI?
Salve suas chaves API como perfis locais no CLI usando comandos como sendmux profiles:set mailbox --api-key "$SENDMUX_MAILBOX_KEY" --default para evitar passar as chaves a cada comando.
Quais tipos de chaves API o CLI suporta?
O CLI utiliza chaves com escopo de mailbox (smx_mbx_) para comandos de envio e mailbox, e chaves com escopo de equipe (smx_root_) para comandos de gerenciamento, garantindo o controle adequado de acesso.
Posso passar dados de requisição a partir de arquivos usando o CLI?
Sim, você pode passar o corpo da requisição inline com --body ou a partir de um arquivo usando --body-file para entrada flexível de comandos.
Como o CLI lida com a formatação de saída?
Por padrão, o CLI imprime JSON formatado para melhor leitura. Use a flag --json para obter uma saída JSON legível por máquina, adequada para automação.
Quais recursos de segurança o CLI oferece para requisições?
O CLI suporta flags de segurança como --idempotency-key, --if-match e --if-none-match para ajudar no gerenciamento de segurança e concorrência das requisições.
Posso sobrescrever a URL base da API no CLI?
Sim, você pode sobrescrever a URL base da API por comando usando --base-url ou para a sessão shell atual configurando a variável de ambiente SENDMUX_BASE_URL.

