LightFile Shot ドキュメント
指定したディレクトリやファイルを最適化するだけの、シンプルなCLIツールです。既存のシステムから呼び出すことで、画像最適化を組み込めます。
はじめに
- 概要ローカルの JPEG・PNG をまとめて最適化するシンプルなCLIツールです。2つの動作モード、フィルタリング、3段階の品質設定、処理の流れを説明します。
- インストール対応OSとシステム要件、Linux・Windows・macOS それぞれへのインストール方法です。最新バイナリとパッケージ配布は bin.ideamans.com にあります。
- ライセンスのセットアップライセンストークンの取得と指定方法です。コマンドラインオプション、環境変数 LF_TOKEN、トークンファイルの3通りがあり、この順に優先されます。
- クイックスタートlightfile-shot を最初に動かすまでの手順です。カレントディレクトリ、指定ディレクトリ、単一ファイル、複製モードの4通りを実際のコマンドで示します。
目的別ガイド
- 動作モード元のファイルを置き換える上書きモードと、別の場所へ書き出す複製モードの2つがあります。ディレクトリ単位と単一ファイル単位それぞれの書き方を示します。
- ファイルフィルタリング処理する画像を絞り込む条件です。ファイルサイズの上限下限とその単位、対象拡張子、パターンマッチングによる除外の指定方法を説明します。
- 品質設定画質を low・medium・high の3段階で調整します。それぞれの用途の目安と、JPEG・PNG に別々の品質を指定する方法を説明します。
- ジャーナル機能1ファイルごとの処理結果を NDJSON で記録するジャーナル機能です。記録されるフィールドと処理ステータス、成功したファイルだけを抽出する使い方を説明します。
- ログ機能lightfile-shot のログ出力の制御方法です。debug・info・warn・error の4段階のログレベルと、詳細ログを出す --verbose の使いどころを説明します。
- 表示言語の設定表示言語は起動時に環境から自動判定します。LANGUAGE・LC_ALL などを見る優先順位と判定ルール、明示的に日本語へ固定する方法を説明します。
その他
リファレンス
- コマンドラインオプションlightfile-shot のコマンドラインオプションの完全なリファレンスです。第1引数のソースと第2引数の出力先の意味、各オプションの既定値を説明します。
- 環境変数lightfile-shot が読む環境変数 LF_TOKEN と LOG_LEVEL の説明です。コマンドラインオプション・環境変数・トークンファイルの優先順位もあわせて示します。
- ログメッセージ一覧lightfile-shot が出力するログメッセージの一覧です。完了時に表示される件数と削減効果の読み方、debug から error までのレベル別の出力例を掲載しています。