CLI da Scribe: suas assinaturas no terminal e agentes locais

A CLI da Scribe (@scribemail/cli) traz toda a superfície de ferramentas da Scribe para sua máquina. Ela tem duas faces:

Um servidor MCP local — scribe mcp disponibiliza exatamente as mesmas ferramentas do servidor MCP hospedado para qualquer agente capaz de executar um comando (Claude Code, Claude Desktop, Cursor e qualquer cliente MCP stdio), rodando como você após um único login pelo navegador.
Uma linha de comando comum — cada ferramenta também é um subcomando (scribe signatures list, scribe campaigns schedule), com saída JSON pensada para scripts e shells.

Ambas são geradas a partir do mesmo código do servidor hospedado em mcp.scribe-mail.com, então as ferramentas, os nomes e o comportamento nunca divergem.

Instalar e entrar

Instalar do npm

Requer Node.js 20 ou superior.

npm install -g @scribemail/cli

Entrar pelo navegador

scribe login

Seu navegador abre e você entra com sua conta Scribe — sem chave de API para criar ou colar. As credenciais ficam em ~/.config/scribe/credentials.json com permissões restritas ao proprietário e são renovadas automaticamente.

Verificar a sessão

scribe whoami

Mostra o usuário logado, o espaço de trabalho e o estado do token.

O membro logado precisa ser proprietário ou administrador do espaço de trabalho, e o plano do espaço de trabalho precisa incluir acesso à API. Um login corresponde a um espaço de trabalho — execute scribe login novamente para trocar.

Disponibilizar um agente local via MCP

claude mcp add --scope user scribe -- scribe mcp

Para clientes configurados com JSON (Claude Desktop, Cursor e outros):

{
  "mcpServers": {
    "scribe": {
      "command": "scribe",
      "args": ["mcp"]
    }
  }
}

Prefira a CLI ao endpoint hospedado quando seu agente roda localmente e você quer que as chamadas de ferramenta sejam executadas na sessão de terminal em que você já está autenticado, ou quando seu cliente só se comunica via stdio. O endpoint hospedado (veja Conectar seu assistente) continua sendo a escolha certa para assistentes de chat como Claude na web e ChatGPT.

Uso pelo shell

Os resultados são JSON no stdout; os erros são texto legível no stderr.

scribe signatures list --limit 10
scribe signatures create --name "Sales" --draft-content @tree.json
scribe signatures publish --id 0c9f…
scribe teammates list --auto-paginate
scribe analytics views --start-date 2026-07-01 --end-date 2026-08-01 --group-by signature_template
scribe docs search "dns setup"

Convenções úteis:

scribe tools lista todas as ferramentas MCP e seus comandos de CLI; scribe call <tool_name> --json '{...}' chama qualquer ferramenta pelo nome MCP exato.
Campos complexos, como árvores de conteúdo de assinatura, aceitam JSON inline, @file ou - para stdin. --json pode fornecer todo o objeto de argumentos, e flags explícitas o sobrescrevem.
Booleanos são --flag / --no-flag; omitir os dois deixa o campo de fora, então atualizações parciais nunca sobrescrevem valores por engano.
Códigos de saída: 0 sucesso, 1 erro de API ou ferramenta, 2 erro de uso, 3 não autenticado.

Comandos por área

Grupo	Comandos
`signatures`	`list` `create` `update` `delete` `publish` `install` `preview` `html` `installations`
`signatures variants`	`list` `update` `publish` `delete`
`signatures recipients`	`list` `add` `remove` `set-rules` `add-entities` `remove-entities`
`teammates`, `emails`, `smart-fields`, `folders`, `assets`	`list` `create` `update` `delete`
`campaigns`	`list` `create` `update` `delete` `preview` `schedule` `pause` `resume`
`analytics`	`views` `clicks` `events` `events-summary`
`visitors`	`list` `get` `breakdown`
`integrations`	`list` `entities`
Nível superior	`workspace` · `billing documents` · `content-schema` · `docs search` · `docs read` · `feedback`
Sessão	`login` · `logout` · `whoami` · `mcp` · `tools` · `call`

O comportamento por ferramenta é idêntico ao das ferramentas MCP — consulte a referência de ferramentas.

Uso via SSH

Para fazer login, é necessário um navegador que consiga acessar 127.0.0.1 na máquina que executa a CLI. Em uma máquina remota, encaminhe a porta de callback e imprima a URL em vez de abrir um navegador:

ssh -L 8976:127.0.0.1:8976 yourserver
scribe login --no-browser

Depois, abra a URL impressa no navegador local.

Próximos passos

Referência de ferramentas

Todas as ferramentas da Scribe, agrupadas por área

Skills

Dê ao seu assistente o fluxo de trabalho completo da Scribe

Solução de problemas

Resolva problemas de conexão e de ferramentas

Referência da API

A API REST por trás da CLI e do servidor MCP

Getting started

Product FAQ

Industry

Departments

Company type

Climate

Affiliate

CLI da Scribe: suas assinaturas no terminal e agentes locais

Instalar e entrar

Disponibilizar um agente local via MCP

Uso pelo shell

Comandos por área

Uso via SSH

Próximos passos

Referência de ferramentas

Skills

Solução de problemas

Referência da API

​Instalar e entrar

​Disponibilizar um agente local via MCP

​Uso pelo shell

​Comandos por área

​Uso via SSH

​Próximos passos

Referência de ferramentas

Skills

Solução de problemas

Referência da API

Instalar e entrar

Disponibilizar um agente local via MCP

Uso pelo shell

Comandos por área

Uso via SSH

Próximos passos