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

# Plaud CLI

> Aceda às suas gravações do Plaud a partir do terminal. Navegue, pesquise, leia transcrições, descarregue ficheiros de áudio e veja resumos gerados por IA sem abrir a aplicação.

## Pré-requisitos

* Node.js ≥ 20 — [Descarregar](https://nodejs.org/)
* Uma conta Plaud

***

## Instalar

```bash theme={"system"}
npm install -g @plaud-ai/cli
```

***

## Início rápido

```bash theme={"system"}
plaud login          # faça login pelo navegador
plaud files          # navegue pelas suas gravações
plaud search "Q2"    # encontre uma gravação por palavra-chave
plaud summary <id>   # leia o resumo da IA
plaud transcript <id> # leia a transcrição completa
```

***

## Referência de comandos

### Autenticação

```bash theme={"system"}
plaud login    # faça login pelo navegador — tokens guardados automaticamente
plaud logout   # saia e revogue a autorização
plaud me       # mostra os detalhes da sua conta atual
```

### Navegar

```bash theme={"system"}
plaud files                   # última página de gravações
plaud files --page 2 --page-size 50
plaud recent                  # gravações dos últimos 7 dias
plaud recent --days 30        # gravações dos últimos 30 dias
plaud today                   # gravações apenas de hoje
```

**`plaud files` Opções**

| Opção             | Descrição                 | Padrão |
| ----------------- | ------------------------- | ------ |
| `-p, --page`      | Número da página (1–1000) | `1`    |
| `-s, --page-size` | Itens por página (10–100) | `20`   |

### Pesquisar

```bash theme={"system"}
plaud search <keyword>
plaud search "weekly" --from 2026-04-01 --to 2026-04-30
plaud search "onboarding" --max 10
```

Pesquisa de palavras-chave do lado do cliente (sem distinção entre maiúsculas e minúsculas) contra nomes de gravações. Analisa até 500 gravações mais recentes.

| Opção                 | Descrição                                               |
| --------------------- | ------------------------------------------------------- |
| `--from <YYYY-MM-DD>` | Início do intervalo de datas (inclusivo)                |
| `--to <YYYY-MM-DD>`   | Fim do intervalo de datas (inclusivo)                   |
| `--max <n>`           | Número máximo de resultados a apresentar (padrão: `50`) |

### Ler uma gravação

```bash theme={"system"}
plaud file <id>               # metadados completos e disponibilidade
plaud audio <id>              # URL de download de 24 horas para o áudio
plaud transcript <id>         # transcrição com timestamp
plaud transcript <id> -o transcript.txt   # guardar em ficheiro
plaud summary <id>            # resumo de IA (Markdown)
plaud summary <id> -o summary.md          # guardar em ficheiro
```

### Utilitário

```bash theme={"system"}
plaud version    # mostrar versão instalada e informações de compilação
plaud update     # verificar se há uma versão mais recente e imprimir o comando de atualização
```

***

## Referência de dados

### Campos em `plaud files` / `plaud file`

| Campo        | Descrição                                         |
| ------------ | ------------------------------------------------- |
| `id`         | ID de gravação único — utilize-o noutros comandos |
| `name`       | Nome da gravação                                  |
| `created_at` | Tempo de criação (ISO 8601)                       |
| `duration`   | Duração da gravação                               |

Campos adicionais em `plaud file <id>` apenas:

| Campo           | Descrição                                       |
| --------------- | ----------------------------------------------- |
| `start_at`      | Tempo de início de gravação (ISO 8601)          |
| `serial_number` | Número de série do dispositivo                  |
| `audio`         | Indica se o áudio está disponível para download |
| `transcript`    | Indica se uma transcrição está disponível       |
| `summary`       | Indica se um resumo de IA está disponível       |

### Códigos de saída

| Código | Significado                                   |
| ------ | --------------------------------------------- |
| `0`    | Sucesso                                       |
| `1`    | Argumentos inválidos ou erro desconhecido     |
| `2`    | Falha na autenticação — execute `plaud login` |
| `3`    | Erro de rede — verifique sua conexão          |
| `4`    | Tempo de solicitação esgotado                 |

Todos os erros são redirecionados para o **stderr**, mantendo o stdout livre para o uso de canalizações e scripts:

```
✖ [AUTH_FAILED] Token inválido ou expirado. Execute `plaud login`.
```

***

## Configuração

Tokens são armazenados em `~/.plaud/tokens.json` e geridos automaticamente, sem ser necessária edição manual.

Para uso avançado, crie um ficheiro de configuração opcional em `~/.plaud/cli.yaml`:

```yaml theme={"system"}
api_base: "https://platform.plaud.ai/developer/api"
timeout: 30000   # milissegundos
```

Variáveis de ambiente substituem tanto o arquivo de configuração quanto os padrões embutidos:

| Variável                                  | Propósito                        |
| ----------------------------------------- | -------------------------------- |
| `PLAUD_API_BASE`                          | Substituir a URL base da API     |
| `PLAUD_CLIENT_ID` / `PLAUD_CLI_CLIENT_ID` | ID do cliente OAuth              |
| `PLAUD_CLIENT_SECRET`                     | Segredo do cliente OAuth         |
| `PLAUD_AUTH_URL`                          | Endpoint de autorização          |
| `PLAUD_TOKEN_URL`                         | Endpoint de troca de token       |
| `PLAUD_REFRESH_URL`                       | Endpoint de atualização de token |

***

## Atualizar

```bash theme={"system"}
npm install -g @plaud-ai/cli@latest
```

Ou verifique primeiro:

```bash theme={"system"}
plaud update
```

***

## Desinstalar

```bash theme={"system"}
npm uninstall -g @plaud-ai/cli
rm -rf ~/.plaud
```

***

## Resolução de problemas

| Sintoma                                         | Correção                                                                                   |
| ----------------------------------------------- | ------------------------------------------------------------------------------------------ |
| `401` / «Não autenticado»                       | Executar `plaud login`                                                                     |
| `plaud: command not found`                      | Reabra o seu terminal; confirme que `npm install -g @plaud-ai/cli` foi concluído sem erros |
| Erros na atualização do token                   | Apague `~/.plaud/tokens.json` e execute `plaud login` novamente                            |
| O navegador não abre durante o início de sessão | Copie a URL impressa no terminal e abra-a manualmente                                      |
| `npx` retorna `E404` para `@plaud-ai/cli`       | Execute `npm cache clean --force` e tente novamente                                        |
