PAPERMILL(1)

💖 papermill — the manual page, but make it a group chat 💖

okay bestie, gather round, because this is the papermill(1) page and it's from the User Commands section of the manual, and we are going to understand it, not just scroll past it. 🎀

---

✨ NAME ✨

papermill — it's papermill, babes. that's the name. it's giving iconic, it's giving self-explanatory, we move. 💅

---

🌸 SYNOPSIS 🌸

papermill [OPTIONS] NOTEBOOK_PATH [OUTPUT_PATH]

that's the whole vibe. options, then where the notebook's at, then optionally where it's going. 🦋

---

💜 DESCRIPTION 💜

so this lil utility? it executes one single notebook in a subprocess. one. single. notebook. it's monogamous like that. no cap. 🔥

here's the whole pipeline, and honestly it's so clean:

• papermill takes a source notebook
• applies parameters to that source notebook
• executes the notebook with the specified kernel
• and saves the output in the destination notebook

that's it. that's the whole glow-up arc. ✨

now here's the part that's highkey underrated: the NOTEBOOK_PATH and OUTPUT_PATH can now be replaced by -, which represents stdout and stderr, or by the presence of pipe inputs / outputs. meaning that

<generate input>... | papermill | ...<process output>

with papermill - - being implied by the pipes, it will read a notebook from stdin and write it out to stdout. bestie. the pipes do the work for you. it's literally main character energy. no notes. 👑

---

🎀 OPTIONS 🎀

okay this is the long part, but every single one of these matters, so we're going through all of them. hydrate. 💧

• --help-notebook — displays parameters information for the given notebook path. like a lil peek at what you can pass in before you commit. 🫶
• -p, --parameters TEXT... — parameters to pass to the parameters cell.
• -r, --parameters_raw TEXT... — parameters to be read as raw string.
• -f, --parameters_file TEXT — path to a YAML file containing parameters.
• -y, --parameters_yaml TEXT — a YAML string to be used as parameters.
• -b, --parameters_base64 TEXT — a Base64 encoded YAML string as parameters.
• --inject-input-path — insert the path of the input notebook as PAPERMILL_INPUT_PATH as a notebook parameter.
• --inject-output-path — insert the path of the output notebook as PAPERMILL_OUTPUT_PATH as a notebook parameter.
• --inject-paths — insert the paths of input/output notebooks as PAPERMILL_INPUT_PATH/PAPERMILL_OUTPUT_PATH as notebook parameters.
• --engine TEXT — the execution engine name to use in evaluating the notebook.
• --request-save-on-cell-execute / --no-request-save-on-cell-execute — request save notebook after each cell execution. every. single. cell. 💅
• --autosave-cell-every INTEGER — how often in seconds to autosave the notebook during long cell executions (0 to disable). for when your cell is taking forever and you're scared. 😭
• --prepare-only / --prepare-execute — flag for outputting the notebook without execution, but with parameters applied. bestie this does NOT run anything, it just preps. important difference, don't get it twisted. ⭐
• -k, --kernel TEXT — name of kernel to run. ignores kernel name in the notebook document metadata. yes, it overrides the notebook's own choice. the audacity, we love it. 🔥
• -l, --language TEXT — language for notebook execution. ignores language in the notebook document metadata. same energy, same override. ✨
• --cwd TEXT — working directory to run notebook in.
• --progress-bar / --no-progress-bar — flag for turning on the progress bar. because watching a bar fill up is self care. 🌈
• --log-output / --no-log-output — flag for writing notebook output to the configured logger.
• --stdout-file FILENAME — file to write notebook stdout output to.
• --stderr-file FILENAME — file to write notebook stderr output to.
• --log-level [NOTSET|DEBUG|INFO|WARNING|ERROR|CRITICAL] — set log level. pick your vibe from that exact list, those are the only options, don't freestyle. 🧚
• --start-timeout, --start_timeout INTEGER — time in seconds to wait for kernel to start. (two spellings, both work, we're flexible like that 💖)
• --execution-timeout INTEGER — time in seconds to wait for each cell before failing execution. default: forever. FOREVER bestie. it will wait until the heat death of the universe unless you tell it not to. 😭💀
• --report-mode / --no-report-mode — flag for hiding input.
• --version — flag for displaying the version.
• -h, --help — show this message and exit. the classic. the original. we stan. 👑

---

real talk for a sec 🫶 — a couple of these flags change how your notebook runs, and --prepare-only genuinely skips execution entirely. if you're expecting output and get none, check your flags first. not me being the responsible one for once. 🙈

---

💌 sign-off 💌

that's the page bestie, and it's papermill 2.7.0, dated April 2026, living in the User Commands section of the manual. go execute something gorgeous. slay. periodt. 💅✨🎀🦋