Como instalo o FlipLink CLI?

Rode npm install -g fliplink-cli (requer Node.js 18+), ou use sem instalar com npx fliplink-cli whoami.

Como me autentico no CI?

Passe sua chave como a variável de ambiente FLIPLINK_API_KEY — por exemplo FLIPLINK_API_KEY=YOUR_KEY fliplink flipbook list. Ela nunca é gravada em disco. Localmente, você pode armazená-la uma vez com fliplink config set-key.

O que é o atalho de acesso direto à API?

Qualquer endpoint que ainda não tenha um comando amigável pode ser acessado diretamente com fliplink api , então a CLI cobre toda a API REST desde o primeiro dia.

Dá para usar a CLI em scripts?

Sim. Todo comando imprime uma tabela por padrão e JSON puro com --json (use um pipe para o jq). Os códigos de saída são compatíveis com scripts: 0 sucesso, 1 erro de requisição/HTTP, 2 erro de aplicação (Result: ERROR).

Quantos comandos existem?

87 comandos em 9 grupos (flipbook, profile, account, folder, cname, team, leads, sales, lookup), gerados a partir da mesma especificação de API que a API REST, para que a CLI não possa divergir dos endpoints documentados.

Interface de Linha de Comando

FlipLink CLI

Crie, configure, publique e gerencie seus flipbooks pelo terminal ou na CI — um wrapper fino e scriptável sobre a API REST do FlipLink.

Comece agora Ver a API REST

Instala via npm · 87 comandos · saída em JSON para scripts

Instalação

terminal

npm install -g fliplink-cli
# or run without installing:
npx fliplink-cli whoami

Requer Node.js 18 ou mais recente.

Autenticação

Pegue uma chave de API no seu painel do FlipLink → Assinatura e armazene-a:

setup

fliplink config set-key YOUR_API_KEY
fliplink whoami

Ou passe-a a cada chamada (prático na CI — nunca é gravada em disco):

FLIPLINK_API_KEY=YOUR_API_KEY fliplink flipbook list

Ordem de resolução de toda configuração: variável de ambiente → arquivo de configuração → padrão interno. A chave armazenada fica em ~/.config/fliplink/config.json com permissões chmod 600.

Comandos comuns

terminal

fliplink flipbook create ./deck.pdf --title "Q3 Report" --name q3
fliplink flipbook create-url https://example.com/deck.pdf --title "Q3 Report"
fliplink flipbook list --search report --page-size 25 --sort-by CreatedOn
fliplink flipbook get <flipbookId>
fliplink flipbook publish <flipbookId>
fliplink flipbook unpublish <flipbookId>
fliplink flipbook set-expiry <flipbookId> --days 30
fliplink flipbook share-link <flipbookId>
fliplink flipbook delete <flipbookId>
fliplink leads list --item <flipbookId> --download true

Rode fliplink <command> --help para ver as flags de qualquer comando.

Todos os grupos de comandos

Cada endpoint pode ser acessado como um comando nomeado. Rode fliplink <group> --help para listar os comandos de um grupo.

Grupo	Cobre
flipbook	criar / ler / modificar / excluir + todas as configurações por flipbook (skin, CTAs, captura de leads, acesso, compartilhamento, vendas, rastreamento, …)
profile	get, set
account	assinatura, pagamentos
folder	list
cname	add, list, delete (domínios personalizados)
team	list, get, set, set-active, delete
leads	list, delete, delete-bulk
sales	list
lookup	templates, skins, moedas, música de fundo

Os endpoints do Google Sheets usam uma URL base diferente e são acessíveis apenas pela saída de escape api.

Scripts

Todo comando imprime uma tabela legível por padrão e JSON puro com --json:

terminal

fliplink flipbook list --json | jq '.[].ID'

Códigos de saída: 0 sucesso · 1 erro de requisição/HTTP · 2 erro de aplicação (Result: ERROR).

Autocompletar do shell

Gere um script de autocompletar para o seu shell:

terminal

source <(fliplink completion zsh)    # add to ~/.zshrc
source <(fliplink completion bash)   # add to ~/.bashrc

Saída de escape — todos os endpoints, hoje mesmo

Qualquer endpoint ainda não encapsulado em um comando amigável pode ser acessado diretamente:

terminal

fliplink api GET  /api/list-folders
fliplink api PUT  /api/set-skin/<flipbookId> --data '{"SkinName":"Modern"}'
fliplink api POST /api/create-by-file --file File=./deck.pdf -q Name=deck

Explore todos os endpoints, seus parâmetros e respostas na referência completa da API REST.

Como funciona

A superfície de comandos é gerada a partir da spec da API — o mesmo endpoints.json que alimenta a documentação da API REST — então a CLI não pode divergir da API documentada. Prefere linguagem natural? A mesma API também está disponível como um servidor MCP para assistentes de IA.

Perguntas frequentes

Como instalo o FlipLink CLI?: Rode npm install -g fliplink-cli (requer Node.js 18+), ou use sem instalar com npx fliplink-cli whoami.
Como me autentico no CI?: Passe sua chave como a variável de ambiente FLIPLINK_API_KEY — por exemplo FLIPLINK_API_KEY=YOUR_KEY fliplink flipbook list. Ela nunca é gravada em disco. Localmente, você pode armazená-la uma vez com fliplink config set-key.
O que é o atalho de acesso direto à API?: Qualquer endpoint que ainda não tenha um comando amigável pode ser acessado diretamente com fliplink api <METHOD> <path>, então a CLI cobre toda a API REST desde o primeiro dia.
Dá para usar a CLI em scripts?: Sim. Todo comando imprime uma tabela por padrão e JSON puro com --json (use um pipe para o jq). Os códigos de saída são compatíveis com scripts: 0 sucesso, 1 erro de requisição/HTTP, 2 erro de aplicação (Result: ERROR).
Quantos comandos existem?: 87 comandos em 9 grupos (flipbook, profile, account, folder, cname, team, leads, sales, lookup), gerados a partir da mesma especificação de API que a API REST, para que a CLI não possa divergir dos endpoints documentados.

Continue criando

Referência da API RESTA referência completa de endpoints que a CLI encapsula.Servidor MCPOpere o FlipLink a partir de um assistente de IA em linguagem natural.Automação e integraçõesConecte o FlipLink à sua stack — webhooks, Zapier, Sheets.Primeiros passos com a CLIInstale, faça login e publique seu primeiro flipbook direto do terminal.