Kupcake CLI

Kupcake CLI is the command-line version of Kupcake. It is built for users who want to automate document generation or work directly from the terminal.

Installation on macOS

1. Download the kupcake-cli-<version>.zip archive.
2. Unzip it in a folder of your choice, for example ~/Applications/kupcake-cli/.
3. Make sure node is available in your PATH.
4. Add the launcher to your PATH, for example:

ln -s ~/Applications/kupcake-cli/bin/kupcake /usr/local/bin/kupcake

If /usr/local/bin is not available on your machine, use any directory already present in your PATH.

You can then verify the installation:

kupcake --help

Usage

Use kupcake generate to turn a Markdown file or a .kck file into a PDF. The command accepts a metadata file passed with --metadata.

kupcake generate document.md --metadata metadata.json --template rtone --output document.pdf

Useful options:

• --metadata points to the JSON metadata file
• --template selects the TeX template to use
• --quality controls PDF compression, for example low, medium, or high
• --output sets the output PDF path

Example:

kupcake generate report.kck --metadata metadata.json --template rtone --quality high --output report.pdf

Notes

• The bundle includes the CLI launcher, templates, and runtime tools.
• It does not require a global Pandoc or LaTeX installation.
• If you move the bundle directory, recreate the kupcake symlink if you use one.