FlipLink CLIをはじめよう

ターミナルで作業する人にとって、フリップブックを公開するためにダッシュボードをクリックして回るのは遠回りに感じられます。FlipLink CLI を使えば、作成・公開・共有という一連の流れ — を、シェルから離れることなくすべて完結できます。FlipLink API の上に乗った薄くてスクリプト化しやすいラッパーなので、HTTPリクエストでできることは、たった1つのコマンドで実行できます。

このガイドでは、ゼロの状態から、公開・共有できるフリップブックを作るまでを約5分で進めます。読み終えるころには、CLIのインストールと認証が済み、PDFから直接公開URLを生み出せるようになっています。

CLIをインストールする

CLIはnpmパッケージとして提供されており、Node.js 18以降が必要です。fliplink コマンドをどこからでも使えるように、グローバルにインストールしましょう。

npm install -g fliplink-cli

何も常駐インストールしたくない場合は、npx を使ってコマンドを必要なときだけ実行することもできます。

npx fliplink-cli whoami

どちらの方法でも、使えるコマンドは同じです。このガイドの残りの部分は、グローバルインストールを前提に進めます。

APIキーを設定する

すべてのコマンドは、お使いのFlipLink APIキーで認証されます。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は控えておきましょう — 次の2つのステップで使います。

すでにPDFをどこかにホスティングしていますか？　その場合はアップロードを省略して、URLから作成することもできます。

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

🚀

FlipLinkを無料で試す

PDFを数秒で変換。登録もクレジットカードも不要 — アップロードするだけです。

Drop your PDF here or click to browse

最大40MB

$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 はリクエストそのものが失敗したことを意味します。シェルスクリプトでは、それに応じて対応できます。

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とは？（用語集）