CLI reference
ippon build <input.md> [options] Build the slidesippon <input.md> [options] Shorthand for buildippon serve <input.md> [options] Serve locally and use your phone as a remoteippon init [file] Create a sample Markdown file (default: slide.md)ippon ogp <input.md> [options] Render the cover as an OGP image (1200×630 PNG)ippon current [input.md] Print the current slide and selected text of a served deck as JSONippon skills init [dir] Put an agent skill that uses current in .claude/skills and .agents/skillsippon --help / --versionbuild
| Option | Meaning |
|---|---|
--html |
Output HTML (the default unless --pdf is given) |
--pdf |
Output PDF (requires Chrome, Chromium, or Edge) |
-o, --output <path> |
Output path. Given a directory, writes <input>.html / .pdf inside it. With both --html --pdf, only the extension is replaced |
-w, --watch |
Watch the Markdown and --css files and rebuild on change |
--css <file> |
Additional CSS (Change the look) |
--inline |
Embed relatively referenced images in the HTML as data URIs. Images show up when you hand over just the one HTML file (images that can’t be read keep their path and are reported) |
--no-fetch |
Don’t fetch ::http:: responses at build time |
--browser-path <path> |
Browser to use for PDF (the CHROME_PATH environment variable also works) |
Output path rules
-oends with/or names an existing directory →<input>.html/.pdfinside it.- Both
--htmland--pdf→ only the extension of-ois replaced. - No
-o→ output next to the input, with the same name.
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
| Option | Meaning |
|---|---|
-p, --port <n> |
Port to listen on (a free port is picked automatically if omitted) |
--css <file> |
Additional CSS |
See Use your phone as a remote for details.
ogp
Renders the cover (slide 1) as an OGP image (1200×630 PNG), the image shown when the deck is shared on social media. Like PDF output, it uses your local Chrome, Chromium, or Edge.
ippon ogp slide.md # slide.pngippon ogp slide.md -o dist/ # dist/slide.png| Option | Meaning |
|---|---|
-o, --output <path> |
Output path (default: <input>.png). Given a directory, writes inside it |
--css <file> |
Additional CSS |
--browser-path <path> |
Browser to use (the CHROME_PATH environment variable also works) |
X and similar services need an absolute URL in og:image, so put the published url: in the frontmatter.
The HTML you build then gets <url><input>.png in og:image. Put the image in the same place as the HTML.
---title: 発表タイトルurl: https://slides.example.com/talk/---If you used -o to give it a different name, set that name with image: in the frontmatter.
init
ippon init # create slide.mdippon init talk.md # choose the nameIf the file already exists, it is not overwritten and the command fails with an error.
current
Asks a running ippon serve for the slide shown in the browser and the text selected in the deck,
and prints them as JSON (the same contents as /__current-slide).
ippon current # the server serving Markdown under the current directory (or the newest one if none)ippon current talk.md # the server serving talk.mdippon serve registers its port in ~/.ippon/serve/ while running and removes it on exit.
ippon current looks up servers there, so you don’t need to know the port.
skills init
Writes a SKILL.md for Agent Skills that teaches an agent how to use ippon current.
ippon skills init # write to the current directoryippon skills init ../talk # write to the given directory| Location | Read by |
|---|---|
.claude/skills/ippon-slides/SKILL.md |
Claude Code |
.agents/skills/ippon-slides/SKILL.md |
Codex and other agents that read .agents/skills |
Existing SKILL.md files are not overwritten (so your edits are kept). Use --force to overwrite them.
Environment variables
CHROME_PATH… path to the browser used for PDF output (same as--browser-path).