Primeiros passos com a CLI do FlipLink

Se você vive no terminal, clicar por um painel para publicar um flipbook parece um desvio. A CLI do FlipLink deixa você fazer tudo — criar, publicar e compartilhar — sem sair do seu shell. É um wrapper leve e programável sobre a API do FlipLink, então tudo o que você faz com uma requisição HTTP, você faz com um único comando.

Este guia leva você do zero a um flipbook publicado e compartilhável em cerca de cinco minutos. No fim, você terá a CLI instalada, autenticada e gerando uma URL pública direto de um PDF.

Instale a CLI

A CLI é distribuída como um pacote npm e precisa do Node.js 18 ou mais novo. Instale globalmente para que o comando fliplink fique disponível em qualquer lugar:

npm install -g fliplink-cli

Prefere não instalar nada permanentemente? Você pode rodar qualquer comando na hora com o npx:

npx fliplink-cli whoami

De qualquer forma, o mesmo conjunto de comandos está disponível. O resto deste guia parte de uma instalação global.

Defina sua chave de API

Todo comando se autentica com sua chave de API do FlipLink. Pegue uma fazendo login em https://go.fliplink.me e abrindo a página Subscription.

Guarde a chave uma vez e a CLI lembra dela:

fliplink config set-key YOUR_API_KEY

Isso grava a chave em ~/.config/fliplink/config.json com permissões 600, então só o seu usuário pode lê-la. Para CI/CD ou scripts em que você prefere não gravar um arquivo de configuração, defina uma variável de ambiente:

export FLIPLINK_API_KEY=YOUR_API_KEY

A CLI resolve as credenciais nesta ordem: primeiro a variável de ambiente FLIPLINK_API_KEY, depois o arquivo de configuração. Trate a chave como uma senha — nunca faça commit dela em um repositório. Se quiser entender mais a fundo como essa autenticação por cabeçalho funciona, o verbete da API no glossário é uma boa introdução.

Confirme que você está conectado

Antes de qualquer coisa, faça um teste rápido de saúde. O whoami chama o endpoint de identidade da conta e confirma que sua chave funciona:

fliplink whoami

Uma resposta bem-sucedida exibe os detalhes da sua conta (e o tamanho máximo de upload). Se você vir um erro de autenticação, sua chave está faltando ou errada — rode config set-key de novo e tente outra vez. Essa é a mesma primeira chamada que recomendamos para a própria API, então é um teste de fumaça confiável.

Crie um flipbook a partir de um PDF

Agora a parte divertida. Aponte a CLI para um PDF local e dê um título a ele:

fliplink flipbook create ./deck.pdf --title "Q3 Report" --name q3

O --title é o que os leitores veem, e o --name é um rótulo interno que você vai usar para encontrá-lo depois. O comando envia o arquivo, inicia a conversão e retorna o ID do novo flipbook. Anote esse ID — você vai usá-lo nos próximos dois passos.

Já tem o PDF hospedado em algum lugar? Pule o upload e crie a partir de uma URL:

fliplink flipbook create-url https://example.com/deck.pdf --title "Q3 Report"

🚀

Experimente o FlipLink Grátis

Converta seu PDF em segundos. Sem cadastro, sem cartão de crédito — basta enviar o arquivo.

Drop your PDF here or click to browse

Máx 40MB

Os planos pagos a partir de $39 aumentam esse limite para 150 MB.

Publique e compartilhe

Um flipbook recém-criado não fica público até você publicá-lo. Aqui está a sequência completa — criar, publicar e então buscar o link de compartilhamento — usando o ID retornado em cada passo:

# 1. Create from a PDF and note the returned ID
fliplink flipbook create ./deck.pdf --title "Q3 Report" --name q3

# 2. Publish it (use the ID from step 1)
fliplink flipbook publish 90001

# 3. Get the public share link
fliplink flipbook share-link 90001

O publish deixa o flipbook no ar; o share-link retorna a URL que você entrega aos leitores. Mudou de ideia? O fliplink flipbook unpublish 90001 o tira do ar de novo sem apagar nada.

Saída legível por máquina com --json

Por padrão, a CLI imprime uma saída amigável para humanos. Adicione --json a qualquer comando para receber a resposta JSON bruta — perfeito para canalizar para o jq ou capturar um valor em um script:

fliplink flipbook create ./deck.pdf --title "Q3 Report" --json | jq -r '.ID'

Esse comando de uma linha cria um flipbook e imprime apenas o ID dele, pronto para alimentar o próximo comando. Essa é a base de toda automação que você vai construir — veja Automação e Integrações para onde isso leva.

Códigos de saída para scripts

A CLI usa códigos de saída previsíveis para que seus scripts possam ramificar em sucesso ou falha sem analisar a saída:

Essa separação importa: um 2 significa que sua requisição chegou ao FlipLink, mas foi rejeitada por um motivo de negócio (entrada inválida, cota excedida), enquanto um 1 significa que a própria requisição falhou. Em um script de shell, você pode reagir de acordo:

fliplink flipbook publish 90001 || echo "Publish failed with exit code $?"

Para onde ir agora

Agora você tem o ciclo principal: instalar, autenticar, criar, publicar, compartilhar. A partir daqui, você pode conectar a CLI a qualquer coisa que execute comandos.

• Referência completa de comandos — cada flag e subcomando está nos docs da CLI.
• Automatize — rode a mesma sequência em um agendamento ou a cada commit. Nosso guia para automatizar a publicação de flipbooks em CI/CD mostra um pipeline real.
• Precisa do poder bruto da API? — a CLI envolve a referência da API, e a saída de emergência fliplink api alcança qualquer endpoint que os comandos nomeados ainda não cobrem.

Depois de publicar seu primeiro flipbook pelo terminal, o painel começa a parecer opcional — que é exatamente a ideia.

Leituras relacionadas

• Documentação da CLI do FlipLink — a referência completa de comandos
• CLI vs API vs MCP: qual você deve usar?
• Automatize a publicação de flipbooks em CI/CD
• Como usar a API do FlipLink para integrações personalizadas
• Automação e Integrações
• O que é uma API? (glossário)