CLI リファレンス
ippon build <input.md> [options] スライドをビルドするippon <input.md> [options] build の省略形ippon serve <input.md> [options] ローカルで配信し、スマホをリモコンにするippon init [file] サンプルの Markdown を作る(既定: slide.md)ippon ogp <input.md> [options] 表紙を OGP 画像(1200×630 の PNG)にするippon current [input.md] serve 中のデッキで表示中のスライドと選択中の文字列を JSON で出すippon skills init [dir] current を使うエージェント用スキルを .claude/skills と .agents/skills に置くippon --help / --versionbuild
| オプション | 意味 |
|---|---|
--html |
HTML を出力する(--pdf がなければ既定) |
--pdf |
PDF を出力する(Chrome / Chromium / Edge が必要) |
-o, --output <path> |
出力先。ディレクトリ指定でその中に <input>.html / .pdf を作る。--html --pdf 両方指定時は拡張子だけ差し替える |
-w, --watch |
Markdown と --css の変更を監視して再ビルド |
--css <file> |
追加の CSS(見た目を変える) |
--inline |
相対パスの画像を data URI で HTML に埋め込む。HTML 1 ファイルを渡すだけで画像も出る(読めない画像はパスのまま残して知らせる) |
--no-fetch |
::http:: のレスポンスをビルド時に取得しない |
--browser-path <path> |
PDF に使うブラウザ(環境変数 CHROME_PATH でも可) |
出力先の決まり方
-oの末尾が/、または既存ディレクトリ → その中に<input>.html/.pdf。--htmlと--pdfの両方 →-oの拡張子だけ差し替える。- 省略時 → 入力と同じ場所に同名で出力。
ippon build slide.md --htmlippon build slide.md --pdf -o dist/ippon build slide.md --html --pdf -o dist/talkippon build slide.md --html -wippon build slide.md --inlineserve
| オプション | 意味 |
|---|---|
-p, --port <n> |
待ち受けポート(省略時は空きポートを自動選択) |
--css <file> |
追加の CSS |
詳しくは スマホをリモコンにする を参照してください。
ogp
表紙(1 枚目)を、SNS で共有したときに出る OGP 画像(1200×630 の PNG)にします。 PDF と同じくローカルの Chrome / Chromium / Edge を使います。
ippon ogp slide.md # slide.pngippon ogp slide.md -o dist/ # dist/slide.png| オプション | 意味 |
|---|---|
-o, --output <path> |
出力先(既定: <input>.png)。ディレクトリを指定するとその中に作る |
--css <file> |
追加の CSS |
--browser-path <path> |
使うブラウザ(環境変数 CHROME_PATH でも可) |
X などは og:image に絶対 URL が必要なので、frontmatter に公開先の url: を書いておきます。
build した HTML の og:image に <url><input>.png が入ります。HTML と同じ場所に画像も置いてください。
---title: 発表タイトルurl: https://slides.example.com/talk/----o で別の名前にしたときは、frontmatter の image: でその名前を指定します。
init
ippon init # slide.md を作るippon init talk.md # 名前を指定既存のファイルがある場合は上書きせずエラーにします。
current
起動中の ippon serve に問い合わせ、ブラウザで表示中のスライドとデッキ上で選択中の文字列を
JSON で出します(中身は /__current-slide と同じ)。
ippon current # 今いるディレクトリ配下の Markdown を serve しているもの(無ければ一番新しいもの)ippon current talk.md # talk.md を serve しているものippon serve は起動中のポートを ~/.ippon/serve/ に登録し、終了時に消します。
ippon current はそこからサーバを探すので、ポートを知らなくても使えます。
skills init
ippon current の使い方を教える Agent Skills の SKILL.md を置きます。
ippon skills init # 今いるディレクトリに置くippon skills init ../talk # 指定したディレクトリに置く| 置き場所 | 読むエージェント |
|---|---|
.claude/skills/ippon-slides/SKILL.md |
Claude Code |
.agents/skills/ippon-slides/SKILL.md |
Codex など .agents/skills を読むエージェント |
既にある SKILL.md は上書きしません(手を入れた内容を消さないため)。--force で上書きします。
環境変数
CHROME_PATH… PDF 出力に使うブラウザのパス(--browser-pathと同じ)。