---
title: "Flowsery CLI"
description: "Instale o CLI do Flowsery, inicie sessão com um token de API e comande todo o Flowsery do seu terminal ou de um script. Saída JSON e códigos de saída reais."
url: "https://flowsery.com/pt/features/cli/docs"
---

[Voltar aos agentes de IA](https://flowsery.com/pt/features/agents)

# Flowsery CLI

Comande o Flowsery do seu terminal ou de um script. Um binário só, sem runtime para manter, e cada comando pode imprimir JSON.

## Instalação

Escolha a que servir à sua máquina. O Homebrew e o script curl instalam um binário autónomo, por isso não é preciso Node.

npm

```
npm install -g @flowsery/cli
```

Homebrew (macOS, Linux)

```
brew trust Flowsery/tap && brew install Flowsery/tap/flowsery
```

Script de instalação (macOS, Linux)

```
curl -fsSL https://flowsery.com/install.sh | sh
```

Executar uma vez, sem instalar

```
npx -p @flowsery/cli flowsery --help
```

O Homebrew 7 recusa carregar uma fórmula de um tap de terceiros enquanto não a aprovar, que é o que o brew trust faz. Sem esse passo, install e upgrade param com «Refusing to load formula from untrusted tap».

A instalação deixa dois nomes para o mesmo programa. O curto é `fsy`.

## Autenticação

Crie um token de API e passe-o ao login. Os tokens ficam nas definições do seu espaço de trabalho: [API e agentes de IA](https://flowsery.com/pt/api-tokens).

```
flowsery login
```

O comando abre a página de tokens, lê o token num campo oculto, verifica localmente o prefixo `flow_ws_` e confirma-o com uma chamada à API antes de o gravar em disco com modo 0600\. Se a verificação falhar, nada é guardado.

Em CI, passe o token por um pipe e salte a pergunta

```
echo "$MY_SECRET" | flowsery login --token-stdin
```

Ou não guarde nada e passe-o em cada comando

```
FLOWSERY_API_TOKEN=flow_ws_your_token flowsery whoami
```

## Começar depressa

Uma semana de tráfego, os principais referenciadores num mês, e depois uma vista ao vivo.

```
flowsery stats --range 7d
flowsery breakdown referrers --range 30d --limit 10
flowsery live
```

## Comandos

Todos os comandos aceitam --help, e quase todos aceitam --json. Corra flowsery doctor se algo parecer errado.

Entrar

| flowsery login  | Guardar um token de API nesta máquina, depois de confirmar que funciona |
| --------------- | ----------------------------------------------------------------------- |
| flowsery logout | Remover o token guardado                                                |
| flowsery whoami | Mostrar que token está em uso e a que dá acesso                         |

Trabalho do dia a dia

| flowsery site      | Os sites sobre os quais este token pode reportar                 |
| ------------------ | ---------------------------------------------------------------- |
| flowsery stats     | Tráfego, receita e números em tempo real                         |
| flowsery breakdown | Visitantes e receita agrupados por uma dimensão                  |
| flowsery goal      | Objetivos cumpridos, e as escritas que os registam               |
| flowsery payment   | Escritas de receita                                              |
| flowsery issue     | Problemas de sessão detetados por IA                             |
| flowsery visitor   | Um visitante, a sua identidade, a sua receita e a sua cronologia |
| flowsery live      | Um painel que se atualiza para um site                           |

Saídas de emergência

| flowsery api  | Enviar um pedido autenticado a qualquer endpoint da API   |
| ------------- | --------------------------------------------------------- |
| flowsery mcp  | Imprimir a configuração do servidor MCP para o seu editor |
| flowsery open | Abrir uma página da aplicação web no seu navegador        |

Esta máquina

| flowsery config     | Ler e alterar as preferências do CLI                                             |
| ------------------- | -------------------------------------------------------------------------------- |
| flowsery doctor     | Verificar esta máquina, os ficheiros de configuração, a API e o site predefinido |
| flowsery completion | Imprimir o script de conclusão da shell                                          |

Cada comando lista as suas próprias opções em `flowsery <command> --help`.

## Scripts

Junte --json a qualquer comando e recebe um invólucro estável com ok, command e data, pronto para o jq.

```
flowsery whoami --json
```

Raramente precisa da opção. A saída passa a JSON sozinha quando o stdout não é um terminal ou quando CI está definido, por isso um comando num pipe já devolve JSON.

Códigos de saída

| 0 | Sucesso                                                            |
| - | ------------------------------------------------------------------ |
| 2 | Erro de utilização, por exemplo uma opção em falta ou desconhecida |
| 3 | O token foi recusado ou falta                                      |
| 4 | Nada corresponde a esse identificador                              |
| 5 | A API recusou os dados                                             |
| 7 | Pedidos a mais                                                     |
| 8 | Falha de rede ou tempo esgotado                                    |
| 9 | Limite do plano ou da quota atingido                               |

## Próximos passos

Crie um token, ou ligue a mesma conta a um agente de IA.

[Criar um token de API](https://flowsery.com/pt/api-tokens)[Agentes de IA e MCP](https://flowsery.com/pt/features/agents)