watermint toolbox - The multi-purpose utility command-line tool for web services

figma file export all page

チーム配下のすべてのファイル/ページをエクスポートする

このコマンドは、チーム以下のファイルの全ページをエクスポートします。ただし、エクスポート先に同じファイルが既に存在する場合、watermint toolboxはタイムスタンプを比較し、更新があった場合のみダウンロードを行います。また、ページにコンテンツがない場合は、処理をスキップします。

セキュリティ

watermint toolboxは認証情報をファイルシステム上に保存します. それは次のパスです:

OS パス
Windows %HOMEPATH%\.toolbox\secrets (e.g. C:\Users\bob.toolbox\secrets)
macOS $HOME/.toolbox/secrets (e.g. /Users/bob/.toolbox/secrets)
Linux $HOME/.toolbox/secrets (e.g. /home/bob/.toolbox/secrets)

これらの認証情報ファイルはDropboxサポートを含め誰にも共有しないでください. 不必要になった場合にはこれらのファイルを削除しても問題ありません. 認証情報の削除を確実にしたい場合には、アプリケーションアクセス設定または管理コンソールからアプリケーションへの許可を取り消してください.

方法は次のヘルプセンター記事をご参照ください:

  • Figma: https://help.figma.com/hc/

認可スコープ

説明
Figma: Figmaのファイルに代理でアクセスすることを許可します.

認可

最初の実行では、tbxはあなたのFigmaアカウントへの認可を要求します. Enterキーを押すと、ブラウザが起動します。その後、サービスが認証を行い、tbxがその結果を受け取ります。認証成功のメッセージが表示されたら、ブラウザのウィンドウを閉じてもかまいません。


watermint toolbox xx.x.xxx
==========================

© 2016-2024 Takayuki Okazaki
オープンソースライセンスのもと配布されています. 詳細は`license`コマンドでご覧ください.

認可URLを開きます:
https://www.figma.com/oauth?client_id=xxxxxxxxxxxxxxxxxxx&redirect_uri=http%3A%2F%2Flocalhost%3A7800%2Fconnect%2Fauth&response_type=code&scope=file_read&state=xxxxxxxx

インストール

最新リリースからコンパイル済みのバイナリをダウンロードしてください. Windowsをお使いの方は、tbx-xx.x.xxx-win.zipのようなzipファイルをダウンロードしてください. その後、アーカイブを解凍し、デスクトップ フォルダに tbx.exe を配置します. watermint toolboxは、システムで許可されていれば、システム内のどのパスからでも実行できます. しかし、説明書のサンプルでは、デスクトップ フォルダを使用しています. デスクトップ フォルダ以外にバイナリを配置した場合は、パスを読み替えてください.

利用方法

このドキュメントは”デスクトップ”フォルダを例として使用します.

実行

Windows:

cd $HOME\Desktop
.\tbx.exe figma file export all page -path /LOCAL/PATH/TO/EXPORT -team-id TEAM_ID

macOS, Linux:

$HOME/Desktop/tbx figma file export all page -path /LOCAL/PATH/TO/EXPORT -team-id TEAM_ID

macOS Catalina 10.15以上の場合: macOSは開発者情報を検証します. 現在、tbxはそれに対応していません. 実行時の最初に表示されるダイアログではキャンセルします. 続いて、”システム環境設定”のセキュリティーとプライバシーから一般タブを選択します. 次のようなメッセージが表示されています:

“tbx”は開発元を確認できないため、使用がブロックされました。

“このまま開く”というボタンがあります. リスクを確認の上、開いてください. 2回目の実行ではダイアログに”開く”ボタンがありますので、これを選択します

オプション:

オプション 説明 デフォルト
-format 書き出し形式(png/jpg/svg/pdf) pdf
-path 出力フォルダーパス  
-peer アカウントの別名 default
-scale エクスポートスケールを1~400の範囲でパーセント表示(デフォルト100) 100
-team-id チームID. チームIDを取得するには、自分が所属しているチームのチームページに移動してください. チームIDは、URLのteamという単語の後、チーム名の前に存在することになります.  

共通のオプション:

オプション 説明 デフォルト
-auth-database 認証データベースへのカスタムパス (デフォルト: $HOME/.toolbox/secrets/secrets.db)  
-auto-open 成果物フォルダまたはURLを自動で開く false
-bandwidth-kb コンテンツをアップロードまたはダウンロードする際の帯域幅制限(Kバイト毎秒). 0の場合、制限を行わない 0
-budget-memory メモリの割り当て目標 (メモリ使用量を減らすために幾つかの機能が制限されます) normal
-budget-storage ストレージの利用目標 (ストレージ利用を減らすためログ、機能を限定します) normal
-concurrency 指定した並列度で並列処理を行います プロセッサー数
-debug デバッグモードを有効にする false
-experiment 実験的機能を有効化する  
-extra 追加パラメータファイルのパス  
-lang 表示言語 auto
-output 出力書式 (none/text/markdown/json) text
-output-filter 出力フィルタ・クエリ(jq構文)。レポートの出力はjq構文を使ってフィルタリングされる。このオプションは、レポートがJSONとして出力される場合にのみ適用される。  
-proxy HTTP/HTTPS プロクシ (hostname:port). プロキシの設定を省略したい場合はDIRECTを指定してください  
-quiet エラー以外のメッセージを抑制し、出力をJSONLフォーマットに変更します false
-retain-job-data ジョブデータ保持ポリシー default
-secure トークンをファイルに保存しません false
-skip-logging ローカルストレージへのログ保存をスキップ false
-verbose 現在の操作を詳細に表示します. false
-workspace ワークスペースへのパス  

ネットワークプロクシの設定

プログラムはシステム設定から自動的にプロクシ設定情報を取得します. しかしながら、それでもエラーが発生する場合には明示的にプロクシを指定することができます. -proxy オプションを利用します, -proxy ホスト名:ポート番号のように指定してください. なお、現在のところ認証が必要なプロクシには対応していません.

}