FlipLink CLI
Создавайте, настраивайте, публикуйте флипбуки и управляйте ими из терминала или CI — тонкая скриптуемая обёртка над REST API FlipLink.
Устанавливается через npm · 87 команд · вывод в JSON для скриптов
Установка
npm install -g fliplink-cli
# or run without installing:
npx fliplink-cli whoamiТребуется Node.js 18 или новее.
Аутентификация
Получите API-ключ в панели FlipLink → Подписка, затем сохраните его:
fliplink config set-key YOUR_API_KEY
fliplink whoamiИли передавайте его при каждом вызове (удобно в CI — на диск не записывается):
FLIPLINK_API_KEY=YOUR_API_KEY fliplink flipbook listПорядок разрешения для любой настройки: переменная окружения → файл конфигурации → встроенное значение по умолчанию. Сохранённый ключ лежит в ~/.config/fliplink/config.json с правами chmod 600.
Частые команды
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Выполните fliplink <command> --help, чтобы увидеть флаги любой команды.
Все группы команд
Каждый эндпоинт доступен как именованная команда. Выполните fliplink <group> --help, чтобы вывести команды группы.
| Группа | Что охватывает |
|---|---|
| flipbook | создание / чтение / изменение / удаление + все настройки флипбука (оформление, призывы к действию, сбор лидов, доступ, общий доступ, продажи, отслеживание, …) |
| profile | получить, задать |
| account | подписка, платежи |
| folder | список |
| cname | добавить, список, удалить (собственные домены) |
| team | список, получить, задать, выбрать активную, удалить |
| leads | список, удалить, удалить массово |
| sales | список |
| lookup | шаблоны, оформления, валюты, фоновая музыка |
Эндпоинты Google Sheets используют другой базовый URL и доступны только через обходную команду api.
Скрипты
Каждая команда по умолчанию выводит читаемую таблицу, а с флагом --json — чистый JSON:
fliplink flipbook list --json | jq '.[].ID'Коды завершения: 0 — успех · 1 — ошибка запроса/HTTP · 2 — ошибка приложения (Result: ERROR).
Автодополнение в оболочке
Сгенерируйте скрипт автодополнения для вашей оболочки:
source <(fliplink completion zsh) # add to ~/.zshrc
source <(fliplink completion bash) # add to ~/.bashrcОбходная команда — любой эндпоинт уже сегодня
Любой эндпоинт, ещё не обёрнутый в удобную команду, доступен напрямую:
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Все эндпоинты, их параметры и ответы смотрите в полном справочнике REST API.
Как это работает
Набор команд генерируется из спецификации API — того же endpoints.json, что лежит в основе документации REST API, — поэтому CLI не может разойтись с задокументированным API. Предпочитаете естественный язык? Тот же API доступен и как MCP-сервер для ИИ-ассистентов.
Частые вопросы
- Как установить FlipLink CLI?
Выполните
npm install -g fliplink-cli(нужен Node.js 18+) или используйте без установки черезnpx fliplink-cli whoami.- Как пройти аутентификацию в CI?
Передайте ключ в переменной окружения
FLIPLINK_API_KEY— например,FLIPLINK_API_KEY=YOUR_KEY fliplink flipbook list. Он никогда не записывается на диск. Локально ключ можно сохранить один раз командойfliplink config set-key.- Что такое запасной путь через API?
Любой эндпоинт, для которого пока нет удобной команды, доступен напрямую через
fliplink api <METHOD> <path>, поэтому CLI покрывает весь REST API с первого дня.- Можно ли использовать CLI в скриптах?
Да. Каждая команда по умолчанию выводит таблицу, а с флагом
--json— необработанный JSON (его удобно передать вjq). Коды выхода подходят для скриптов:0— успех,1— ошибка запроса или HTTP,2— ошибка приложения (Result: ERROR).- Сколько всего команд?
87 команд в 9 группах (flipbook, profile, account, folder, cname, team, leads, sales, lookup), сгенерированных из той же спецификации API, что и REST API, поэтому CLI не может разойтись с документированными эндпоинтами.