> ## Documentation Index
> Fetch the complete documentation index at: https://docs.so-me.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI de redes sociais: agende posts pelo terminal

> Instale a CLI do Social media studio para agendar posts, gerenciar rascunhos e mídia e consultar análises pelo terminal ou por scripts, usando a sua chave de API.

A CLI do Social media studio permite gerenciar posts, rascunhos, contas, mídia, a caixa de entrada social, análises, geração com IA e muito mais, diretamente do terminal. Ela gera JSON por padrão, o que facilita encadeá-la com `jq` ou usá-la em scripts e pipelines de CI/CD.

O pacote inclui dois binários:

| Binário | URL da API padrão | Caso de uso |
| - | - | - |
| `so-me` | `https://api.so-me.studio` | Produção (padrão) |
| `so-me-dev` | `http://localhost:8000` | Desenvolvimento local com um backend próprio |

> [!NOTE]
>
> Esta página documenta a **versão 2.2.0** da CLI (`@social-media-scheduler/cli`). Todos os comandos usam a sintaxe com dois-pontos, por exemplo `posts:list`, `media:upload`, `ai:generate`. Execute `so-me --help` para ver a lista completa de comandos ou `so-me <command> --help` para as flags de um único comando.

## Instalação

```bash npm theme={null}
npm install -g @social-media-scheduler/cli
```

```bash pnpm theme={null}
pnpm add -g @social-media-scheduler/cli
```

```bash yarn theme={null}
yarn global add @social-media-scheduler/cli
```

```bash npx (sem instalação) theme={null}
npx @social-media-scheduler/cli posts:list
```

> [!NOTE]
>
> Requer **Node.js >= 20.0.0**.

## Autenticação

Você precisa de uma chave de API para usar a CLI. Veja [Autenticação](/pt-BR/authentication.md) para gerar uma.

**Chave de API (recomendado)**

```bash theme={null}
so-me auth:login --api-key sk_live_xxxxxxxxxxxxxxxxxxxxxxxx
```

A chave é armazenada localmente. Todos os comandos futuros a usam automaticamente.

**Login pelo navegador (fluxo de dispositivo)**

```bash theme={null}
so-me auth:login
```

Inicia um fluxo de autorização de dispositivo OAuth2: a CLI exibe uma URL de verificação e um código de uso único, abre o navegador e consulta repetidamente até você aprovar. Uma chave de API é gerada e salva automaticamente se o seu plano oferecer acesso à API (planos Standard, Advanced ou Lifetime).

**Variável de ambiente**

```bash theme={null}
export SOME_API_KEY=sk_live_xxxxxxxxxxxxxxxxxxxxxxxx
so-me posts:list
```

Útil para pipelines de CI/CD e scripts. A variável de ambiente é usada quando nenhuma chave é informada por `--api-key` nem há credenciais armazenadas.

Verifique a sua autenticação:

```bash theme={null}
so-me auth:status        # mostra a chave armazenada + a URL da API
so-me auth:whoami        # verifica a chave na API; exibe usuário + organização
```

## Opções globais

Todos os comandos aceitam estas flags. As formas longa e curta são mostradas quando existe um alias curto.

| Opção | Descrição |
| - | - |
| `--api-key <key>` | Substitui a chave de API armazenada neste comando |
| `--api-url <url>` | Substitui a URL base da API (padrão: `https://api.so-me.studio`, ou `http://localhost:8000` para `so-me-dev`) |
| `--json` | Saída em JSON (**padrão**) |
| `--table` | Saída em tabela formatada |
| `--verbose` | Mostra informações detalhadas de erro |
| `-V, --version` | Exibe a versão da CLI (`2.2.0`) |
| `-h, --help` | Mostra a ajuda da CLI ou de um comando |

## Formatos de saída

A saída é JSON por padrão. Passe `--table` para uma tabela legível nos comandos que a oferecem.

**JSON (padrão)**

```bash theme={null}
so-me posts:list
```

```json theme={null}
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "text": "Hello world!",
    "socialMedia": "TWITTER",
    "postStatus": "SCHEDULED",
    "scheduledAt": "2026-04-12T09:00:00.000Z"
  }
]
```

**Tabela**

```bash theme={null}
so-me posts:list --table
```

```
┌──────────────┬───────────────┬──────────┬───────────┐
│ ID           │ Text          │ Platform │ Status    │
├──────────────┼───────────────┼──────────┼───────────┤
│ 550e8400...  │ Hello world!  │ TWITTER  │ SCHEDULED │
└──────────────┴───────────────┴──────────┴───────────┘
```

### Paginação

A maioria dos comandos de listagem aceita flags de paginação:

| Flag | Descrição | Padrão |
| - | - | - |
| `--page <n>` | Número da página a buscar | `1` |
| `--limit <n>` | Itens por página | específico de cada comando |
| `--all` | Busca todas as páginas (onde houver suporte) | desativado |

```bash theme={null}
so-me posts:list --page 2 --limit 50
so-me media:list --all --table
```

## Variáveis de ambiente

| Variável | Descrição | Padrão |
| - | - | - |
| `SOME_API_KEY` | Chave de API (alternativa à flag `--api-key` ou a `auth:login`) | — |
| `SOME_API_URL` | URL base da API | `https://api.so-me.studio` (`so-me`) / `http://localhost:8000` (`so-me-dev`) |

## Grupos de comandos

A CLI registra os grupos de comandos a seguir. Cada um leva à sua referência detalhada.

> **[Autenticação](/pt-BR/cli/auth.md)**
>
> Login (chave de API ou fluxo de dispositivo), logout, status, whoami

> **[Posts](/pt-BR/cli/posts.md)**
>
> Crie, agende, atualize, tente novamente, reenvie e exclua posts; visualização de calendário

> **[Rascunhos](/pt-BR/cli/drafts.md)**
>
> Crie, atualize e exclua rascunhos e converta-os em posts agendados

> **[Contas](/pt-BR/cli/accounts.md)**
>
> Conecte, liste, inspecione e remova contas sociais

> **[Mídia](/pt-BR/cli/media.md)**
>
> Envie, busque, organize em pastas, renomeie, mova e exclua arquivos

> **[Análises](/pt-BR/cli/analytics.md)**
>
> Análises por plataforma e por post

> **[Caixa de entrada](/pt-BR/cli/inbox.md)**
>
> Conversas, mensagens, respostas, respostas salvas, resolver, inscrições

> **[Aprovações](/pt-BR/cli/approvals.md)**
>
> Liste, aprove e rejeite posts pendentes

> **[Equipes](/pt-BR/cli/teams.md)**
>
> Convide, liste, atualize e remova membros; gerencie convites

> **[Links na bio](/pt-BR/cli/biolinks.md)**
>
> Crie e gerencie páginas de link na bio, botões, posts, temas e publicação

> **[Configurações](/pt-BR/cli/settings.md)**
>
> Perfil, organizações, tenants, chaves de API, uso, cobrança, código de indicação

> **[IA](/pt-BR/cli/ai.md)**
>
> Gere texto, imagens e vídeos UGC/avatar; consulte histórico, avatares e sons

> **[Comentários](/pt-BR/cli/comments.md)**
>
> Liste, adicione, edite, exclua e marque como lidos os comentários de posts

> **[Suporte](/pt-BR/cli/support.md)**
>
> Abra e liste tickets, leia e envie mensagens

> **[Modelos](/pt-BR/cli/templates.md)**
>
> Liste, inspecione e renderize modelos de conteúdo (memes, cards de citação, depoimentos)

> **[Webhooks](/pt-BR/cli/webhooks.md)**
>
> Crie, liste, atualize, teste, reenvie e inspecione entregas de webhooks

> **[Cobrança](/pt-BR/cli/billing.md)**
>
> Veja planos, recursos dos planos e complementos

> **[WhatsApp](/pt-BR/cli/whatsapp.md)**
>
> Gerencie modelos do WhatsApp Business, envie mídia e mensagens

> **[Agente](/pt-BR/mcp/overview.md)**
>
> Exporte o catálogo canônico de ferramentas para OpenClaw, Hermes, OpenAI, Anthropic e MCP

### Referência dos grupos de comandos

| Grupo | Prefixo | O que faz |
| - | - | - |
| Autenticação | `auth:` | Autentica (`auth:login`), verifica o status (`auth:status`), confirma a identidade (`auth:whoami`) e encerra a sessão (`auth:logout`) |
| Posts | `posts:` | Ciclo de vida completo do post: `posts:create`, `posts:list`, `posts:get`, `posts:update`, `posts:schedule`, `posts:unschedule`, `posts:retry`, `posts:resubmit`, `posts:delete`, `posts:bulk-delete`, `posts:calendar` |
| Rascunhos | `drafts:` | `drafts:create`, `drafts:list`, `drafts:get`, `drafts:update`, `drafts:delete`, `drafts:convert` |
| Contas | `accounts:` | `accounts:connect`, `accounts:list`, `accounts:get`, `accounts:get-details`, `accounts:remove`, `accounts:remove-by-id` |
| Mídia | `media:` | `media:upload`, `media:list`, `media:get`, `media:search`, `media:rename`, `media:move`, `media:delete`, `media:bulk-delete`, além das operações de pasta (`media:folders`, `media:create-folder`, `media:rename-folder`, `media:move-folder`) |
| Análises | `analytics:` | `analytics:platform`, `analytics:post` |
| Caixa de entrada | `inbox:` | `inbox:list`, `inbox:messages`, `inbox:reply`, `inbox:read`, `inbox:resolve`, `inbox:delete`, respostas salvas (`inbox:saved-replies`, `inbox:create-reply`, `inbox:edit-reply`, `inbox:delete-reply`) e inscrições da caixa de entrada estendida (`inbox:subscribe`, `inbox:unsubscribe`, `inbox:enable`, `inbox:disable`) |
| Aprovações | `approvals:` | `approvals:list`, `approvals:approve`, `approvals:reject` |
| Equipes | `teams:` | `teams:list`, `teams:invite`, `teams:invitations`, `teams:cancel-invite`, `teams:update`, `teams:remove` |
| Links na bio | `biolink:` | Páginas (`biolink:create`, `biolink:list`, `biolink:get`, `biolink:update`, `biolink:delete`, `biolink:publish`, `biolink:public`, `biolink:theme`, `biolink:analytics`), botões (`biolink:buttons`, `biolink:add-button`, `biolink:update-button`, `biolink:delete-button`, `biolink:reorder-buttons`) e posts (`biolink:posts`, `biolink:add-post`, `biolink:update-post`, `biolink:delete-post`, `biolink:reorder-posts`) |
| Configurações | `settings:` | Perfil (`settings:profile`, `settings:update-profile`), organizações (`settings:org`, `settings:create-org`, `settings:update-org`, `settings:delete-org`, `settings:leave-org`, `settings:tenants`), chaves de API (`settings:api-keys`, `settings:create-api-key`, `settings:revoke-api-key`), `settings:usage`, `settings:billing`, `settings:referral-code` |
| IA | `ai:` | Texto (`ai:generate`, `ai:generate-and-schedule`, `ai:history`), imagem (`ai:image`, `ai:image:list`, `ai:image:get`, `ai:image:delete`), vídeo/UGC (`ai:video:generate`, `ai:video:list`, `ai:video:get`, `ai:video:delete`, `ai:video:avatars`, `ai:video:sounds`, `ai:video:hooks`) |
| Comentários | `comments:` | `comments:list`, `comments:add`, `comments:update`, `comments:delete`, `comments:mark-read` |
| Suporte | `support:` | `support:create-ticket`, `support:list-tickets`, `support:get-ticket`, `support:list-messages`, `support:send-message` |
| Modelos | `templates:` | `templates:list`, `templates:get`, `templates:render` |
| Webhooks | `webhooks:` | `webhooks:create`, `webhooks:list`, `webhooks:get`, `webhooks:update`, `webhooks:delete`, `webhooks:test`, `webhooks:retry`, `webhooks:deliveries`, `webhooks:events` |
| Cobrança | `billing:` | `billing:plans`, `billing:plan-features`, `billing:addons` |
| WhatsApp | `whatsapp:` | `whatsapp:templates`, `whatsapp:create-template`, `whatsapp:delete-template`, `whatsapp:upload-media`, `whatsapp:send` |
| Agente | `agent` | `agent export-tools`: busca o catálogo de ferramentas do MCP e o emite no formato do agente de destino |

## Exemplos rápidos

```bash theme={null}
# Criar e agendar um tweet
so-me posts:create -c "Launching today!" --platform TWITTER -s 2026-04-12T09:00:00Z

# Gerar uma legenda com IA para uma plataforma
so-me ai:generate --prompt "Product launch announcement" --platform LINKEDIN

# Gerar uma legenda e agendá-la em uma única etapa
so-me ai:generate-and-schedule --prompt "Product launch announcement" --platform LINKEDIN

# Enviar uma imagem e listar a sua mídia
so-me media:upload ./banner.png
so-me media:list --table

# Consultar as análises da plataforma dos últimos 30 dias
so-me analytics:platform acc-123 --days 30

# Mostrar os comentários de um post
so-me comments:list <post-id>

# Verificar as aprovações pendentes
so-me approvals:list

# Exportar o catálogo de ferramentas do agente em todos os formatos compatíveis
so-me agent export-tools --all --out ./agent-tools

# Encadear a saída JSON com jq
so-me posts:list | jq '.[].text'
```

> **[Scripts e automação](/pt-BR/cli/scripting.md)**
>
> Aprenda a usar a CLI em scripts de shell, pipelines de CI/CD e fluxos de automação.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.