FlipLink CLI
フリップブックの作成・設定・公開・管理を、ターミナルやCIから実行。FlipLink REST APIをスクリプトから扱える、薄いラッパーです。
npm でインストール · 87 個のコマンド · スクリプト向けのJSON出力
インストール
npm install -g fliplink-cli
# or run without installing:
npx fliplink-cli whoamiNode.js 18 以降が必要です。
認証
FlipLink ダッシュボード → Subscription からAPIキーを取得し、保存します。
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 | 作成 / 取得 / 変更 / 削除 + フリップブックごとの各種設定（スキン、CTA、リード獲得、アクセス、共有、販売、トラッキング など） |
| profile | get、set |
| account | サブスクリプション、支払い |
| folder | list |
| cname | add、list、delete（カスタムドメイン） |
| team | list、get、set、set-active、delete |
| leads | list、delete、delete-bulk |
| sales | list |
| 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すべての endpoint とそのパラメーター、レスポンスは完全な REST API リファレンスでご確認いただけます。
仕組み
コマンド群は API仕様から生成 されます。REST API ドキュメント を支えるのと同じ endpoints.json を使うため、CLIがドキュメント化されたAPIからずれることはありません。自然言語で操作したい場合は、同じAPIをAIアシスタント向けの 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）を表します。- コマンドはいくつありますか？
9つのグループ（flipbook、profile、account、folder、cname、team、leads、sales、lookup）にまたがる87個のコマンドがあります。これらはREST APIと同じAPI仕様から生成されるため、CLIが文書化済みのエンドポイントから乖離することはありません。