cappan_cli¶

cappan CLI の全サブコマンドとオプションのリファレンスです。基本的な使い方は CLI ガイド を参照してください。

書式¶

cappan <サブコマンド> [オプション]

fonts¶

システムフォントを検索して一覧表示します。

cappan fonts

出力例:

  Noto Sans CJK JP [Regular]
    /usr/share/fonts/opentype/noto/NotoSansCJK-Regular.ttc [index 0]

render と animate では、一覧に表示されたファミリー名またはフルネームを --font-name で指定できます。

render¶

テキストを単一の画像ファイルとしてレンダリングします。

cappan render --font <path> --text <string> --output <path> [オプション]

必須オプション¶

出力形式¶

出力ファイルの拡張子で形式が自動判定されます。

オプション¶

ストローク・フィルオプション¶

--stroke と --fill を指定すると PaintStack モードでレンダリングされます。配列順序で下から上に描画されます（最初に指定したものが最背面）。

--stroke の書式¶

--stroke "WIDTH,RRGGBB[,key=value...]"

• WIDTH — ストローク幅。6px、0.1em、または数値（px 扱い）
• RRGGBB — 色（16進数）
• オプションの key=value:
• position=outside|center|inside（デフォルト: outside）
• join=round|miter|bevel（デフォルト: round）
• opacity=0.0-1.0（デフォルト: 1.0）
• miter-limit=N（デフォルト: 4.0、正の数）

例:

# 赤い6px縁取り + 白い3px縁取り + 黒塗り
cappan render --font font.ttf --text "Hello" --output out.png \
  --stroke "6px,FF0000" \
  --stroke "3px,FFFFFF" \
  --fill "000000"

# center ストローク + miter join + 半透明
cappan render --font font.ttf --text "Hello" --output out.png \
  --stroke "4px,0000FF,position=center,join=miter,opacity=0.7" \
  --fill "000000"

--fill の書式¶

--fill "RRGGBB[,key=value...]"

• RRGGBB — 色（16進数）
• オプションの key=value:
• opacity=0.0-1.0（デフォルト: 1.0）

--stroke / --fill を指定しない場合は、従来どおり --fg-color による単色フィルでレンダリングされます。

注意: --lcd と --stroke / --fill は併用できません。両方指定した場合、LCD レンダリングは無効化されます。

animate¶

テキストをインクリメンタルアニメーションとしてレンダリングします。出力形式は APNG（デフォルト）またはフレーム連番 PNG です。

# APNGモード
cappan animate --font <path> --text <string> --output <path.apng> [オプション]

# フレーム連番モード
cappan animate --font <path> --text <string> --output-dir <dir> [オプション]

必須オプション¶

--output と --output-dir はどちらか一方が必須です。

共通オプション¶

アニメーションオプション¶

ストラテジー (--strategy)¶

スウィープ方向 (--sweep-direction)¶

タイミング (--timing)¶

イージング (--easing)¶

各グリフの progress に適用するイージング関数です。

輪郭描画順序 (--contour-ordering)¶

contour-trace および medial-axis ストラテジーで使用します。

フレーム連番モードでは <dir>/frame_000.png、frame_001.png … の形式でファイルが出力されます。

svg¶

テキストを SVG ファイルとして出力します。グリフアウトラインがベクターパス（<path> 要素）として書き出されます。

cappan svg --font <path> --text <string> --output <path.svg> [--size <n>]

必須オプション¶

オプション¶

各グリフは個別の <path> 要素になり、カーニングを反映した位置に配置されます。二次ベジェ（Q）、三次ベジェ（C）の両方に対応しています。

subset¶

フォントをサブセットします。指定したテキストに含まれる文字のみを含む軽量フォントファイルを生成します。

cappan subset --font <path> --text <string> --output <path.ttf>

必須オプション¶

CFF フォント（.otf）のサブセッティングには未対応です。TrueType（.ttf）のみ対応しています。

inspect¶

フォントのメタデータ、テーブル構成、整合性チェック、Unicode カバレッジ、OpenType feature、グリフ詳細を表示します。

cappan inspect --font <path> [出力選択オプション]

必須オプション¶

共通オプション¶

出力選択オプション¶

オプションを何も指定しない場合は --summary、--tables、--validate、--coverage、--features を全て表示します。--glyphs、--glyph、--glyph-id は明示的に指定した場合のみ実行されます。

出力内容¶

出力フォーマット (--format)¶

metrics¶

フォントの CSS @font-face メトリクスを表示します。

cappan metrics --font <path> [--compare <path>]

オプション¶

単体表示モード¶

ascent-override、descent-override、line-gap-override を表示します。メトリクスの取得元は OS/2 sTypo → OS/2 usWin → hhea の順にフォールバックします。

比較モード (--compare)¶

2つのフォントのメトリクスを比較し、CSS size-adjust の推奨値を算出します。size-adjust はフォールバックフォントに適用することで、基準フォントに近い表示サイズに調整するための CSS 値です。

共通事項¶

TrueType Collection (.ttc)¶

.ttc ファイルには複数のフォントが格納されています。--font-index で使用するフォントを選択できます。省略時は先頭のフォント（インデックス0）が使用されます。

フォントフォールバック¶

--fallback-font でフォールバックフォントを指定できます（render、animate で使用可能）。複数指定可能です。

動作: - 各文字について、プライマリフォント → フォールバック1 → フォールバック2 … の順にグリフを探索 - 最初にグリフが見つかったフォントのメトリクスとアウトラインを使用 - どのフォントにもグリフがない場合は、プライマリフォントの .notdef グリフを使用 - レイアウト（行の高さ、ベースライン）はプライマリフォントの値を使用 - カーニングは同一フォント内の隣接グリフ間でのみ適用

終了コード¶