Reference

juphyter install

juphyter install [options]

Writes a kernelspec so that JupyterLab and Quarto can run PHP cells.

• A kernel of the same name that juphyter wrote is replaced, and the command reports Replaced. One that something else wrote is refused.
• With --python, the command builds no environment. An interpreter without ipykernel is reported with the pip install command for it.
• Installation describes the default path.

juphyter uninstall

juphyter uninstall [options]

Removes a kernelspec that juphyter installed. A kernelspec of the same name that something else wrote is refused.

juphyter doctor

juphyter doctor [options]

Checks juphyter’s files, the PHP that runs cells, the Python for the kernel, the Python Quarto will use, and every kernel juphyter registered. Changes nothing.

Check the installation lists the summary lines.

juphyter engine

juphyter engine [options]

Runs the execution engine. The kernel’s Python transport starts it and talks to it over the Unix socket named in JUPHYTER_SOCKET. It is not run by hand.

juphyter --version

juphyter --version

Prints the installed version and the PHP running it.

Juphyter\display()

Juphyter\display(mixed $value, mixed ...$more): void

Publishes each value as its own output, in order, part way through a cell.

• Each value is formatted the same way as a cell’s last value.
• Returns nothing, so a cell that ends with display() has no Out[N].
• Outside a kernel, the text/plain form is written to standard output.

Juphyter\display($summary, $plot);

toHtml()

public function toHtml(): string

A class that declares toHtml() is displayed as that HTML.

• text/plain comes from __toString() when the class is Stringable, and from a compact dump otherwise.
• toMimeBundle() takes precedence when a class declares both.
• Rich output has an example.

toMimeBundle()

public function toMimeBundle(): Juphyter\Display\MimeBundle|array

A class that declares toMimeBundle() supplies every output format of its values. It takes precedence over every built-in format, including phibble tables and phiz plots.

• The return value is a MimeBundle, or an array of MIME type to data, such as ['text/html' => '<b>7</b>', 'text/plain' => '7'].
• An array with any key that is not a MIME type, or an empty array, is ignored, and the value is shown as a compact dump.
• When text/plain is missing, it comes from __toString() or a compact dump.
• application/json and Vega-Lite data are PHP arrays, which the kernel encodes as JSON.

final class Score{    public function __construct(private readonly int $value) {}    public function toMimeBundle(): array    {        return [            'text/html' => "<strong>{$this->value}</strong> points",            'text/plain' => "{$this->value} points",        ];    }}

Juphyter\Display\MimeBundle

An immutable, ordered map of MIME type to data, with metadata per type. Every method that changes it returns a new bundle.

Types keep the order they were added in.

juphyter.json

A JSON object in the notebook’s directory or any directory above it. The nearest file applies. Every key is optional.

• Relative paths resolve against the directory that holds the file.
• JUPHYTER_AUTOLOAD in the kernel’s environment takes precedence over autoload.
• A file that is not valid JSON, or not a JSON object, is reported as an error.

Kernel environment

juphyter install writes these variables into the kernelspec’s env.

Quarto settings

Cell options, as #| comments on a cell’s first lines:

• #| echo: false runs the cell and hides its source.
• #| eval: false shows the source without running it.
• #| output: false runs the cell and hides its output.
• #| error: true continues the render past an exception, and keeps the traceback.
• #| fig-cap: "..." captions the cell’s figure.
• #| label: fig-NAME gives the figure a cross-reference label.

Quarto covers output formats and projects.