Начало работы с FlipLink CLI

Если ты живёшь в терминале, кликать по дашборду ради публикации флипбука — лишний крюк. FlipLink CLI позволяет сделать всё — создать, опубликовать и поделиться — не выходя из оболочки. Это тонкая обёртка над FlipLink API, пригодная для скриптов: всё, что можно сделать HTTP-запросом, ты делаешь одной командой.

Это руководство проведёт тебя от нуля до опубликованного флипбука со ссылкой примерно за пять минут. К концу у тебя будет установленный и авторизованный CLI, который выдаёт публичный URL прямо из PDF.

Установка CLI

CLI поставляется как npm-пакет и требует Node.js 18 или новее. Установи его глобально, чтобы команда fliplink была доступна везде:

npm install -g fliplink-cli

Не хочешь ставить ничего навсегда? Любую команду можно запустить по требованию через npx:

npx fliplink-cli whoami

В обоих случаях доступен один и тот же набор команд. Дальше в руководстве предполагается, что CLI установлен глобально.

Укажи свой API-ключ

Каждая команда авторизуется по твоему API-ключу FlipLink. Получи его: войди в аккаунт на https://go.fliplink.me и открой страницу Subscription.

Сохрани ключ один раз — и CLI его запомнит:

fliplink config set-key YOUR_API_KEY

Ключ записывается в ~/.config/fliplink/config.json с правами 600, поэтому прочитать его сможешь только ты. Для CI/CD или скриптов, где не хочется создавать файл конфигурации, задай переменную окружения:

export FLIPLINK_API_KEY=YOUR_API_KEY

CLI ищет учётные данные в таком порядке: сначала переменная окружения FLIPLINK_API_KEY, затем файл конфигурации. Относись к ключу как к паролю — никогда не коммить его в репозиторий. Если хочешь подробнее разобраться, как работает эта авторизация через заголовок, хорошей отправной точкой будет запись об API в глоссарии.

Проверь подключение

Прежде чем браться за что-то ещё, сделай быструю проверку. whoami вызывает эндпоинт идентификации аккаунта и подтверждает, что ключ работает:

fliplink whoami

При успехе выводятся данные твоего аккаунта (и максимальный размер загрузки). Если видишь ошибку авторизации — ключа нет или он неверный — повтори config set-key и попробуй снова. Это тот же первый вызов, который мы рекомендуем для самого API, так что он служит надёжным проверочным тестом.

Создай флипбук из PDF

Теперь самое интересное. Укажи CLI на локальный PDF и задай заголовок:

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

--title видят читатели, а --name — это внутренняя метка, по которой ты потом найдёшь флипбук. Команда загружает файл, запускает конвертацию и возвращает ID нового флипбука. Запиши этот ID — он понадобится для следующих двух шагов.

PDF уже где-то размещён? Пропусти загрузку и создай флипбук из URL:

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

🚀

Попробуйте FlipLink бесплатно

Преобразуйте PDF за секунды. Без регистрации и кредитной карты — просто загрузите файл.

Drop your PDF here or click to browse

Макс. 40 МБ

На платных тарифах от $39 лимит вырастает до 150 MB.

Опубликуй и поделись

Только что созданный флипбук остаётся скрытым, пока ты его не опубликуешь. Вот вся последовательность — создать, опубликовать, затем получить ссылку для доступа — с использованием ID, который возвращается на каждом шаге:

# 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

publish делает флипбук доступным; share-link возвращает URL, который ты передаёшь читателям. Передумал? fliplink flipbook unpublish 90001 снова уводит его офлайн, ничего не удаляя.

Машиночитаемый вывод с --json

По умолчанию CLI печатает понятный человеку вывод. Добавь --json к любой команде, чтобы получить сырой JSON-ответ — идеально, чтобы передать его в jq или сохранить значение в скрипте:

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

Эта однострочная команда создаёт флипбук и выводит только его ID, готовый для следующей команды. Это основа любой автоматизации, которую ты будешь строить — смотри Автоматизация и интеграции, куда это ведёт.

Коды завершения для скриптов

CLI использует предсказуемые коды завершения, чтобы твои скрипты могли ветвиться по успеху или ошибке, не разбирая вывод:

Это разделение важно: 2 означает, что твой запрос дошёл до FlipLink, но был отклонён по бизнес-причине (неверные данные, превышена квота), тогда как 1 означает, что сам запрос не удался. В shell-скрипте можно реагировать по ситуации:

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

Что дальше

Теперь у тебя есть базовый цикл: установить, авторизоваться, создать, опубликовать, поделиться. Отсюда ты можешь встроить CLI во всё, что выполняет команды.

• Полный справочник команд — каждый флаг и подкоманда описаны в документации CLI.
• Автоматизируй — запускай ту же последовательность по расписанию или при каждом коммите. Наше руководство по автоматизации публикации флипбуков в CI/CD разбирает реальный пайплайн.
• Нужна вся мощь API? — CLI оборачивает справочник API, а аварийный выход fliplink api достаёт до любого эндпоинта, который именованные команды пока не покрывают.

Как только ты опубликуешь свой первый флипбук из терминала, дашборд начнёт казаться необязательным — а в этом и весь смысл.

Читайте также

• Документация FlipLink CLI — полный справочник команд
• CLI, API или MCP: что выбрать?
• Автоматизация публикации флипбуков в CI/CD
• Как использовать FlipLink API для собственных интеграций
• Автоматизация и интеграции
• Что такое API? (глоссарий)