用途:当用户要求创建、搭建或编辑 Jupyter Notebook(.ipynb)时使用,主要面向两类模式:实验与探索性分析、教程与教学型讲解。适用于从零创建 .ipynb、把粗略笔记或脚本转成结构化笔记本、重构已有笔记本使其更可复现和易读,以及构建供他人阅读或重跑的实验与教程。
判断方式:探索性、分析性或以假设驱动的请求选 experiment;教学性、分步骤或面向特定受众的请求选 tutorial;编辑已有笔记本按重构处理,保留原意、改进结构。
路径设置(只需一次): export CODEX_HOME="${CODEX_HOME:-$HOME/.codex}" export JUPYTER_NOTEBOOK_CLI="$CODEX_HOME/skills/jupyter-notebook/scripts/new_notebook.py" 用户级技能安装在 $CODEX_HOME/skills(默认 ~/.codex/skills)。
工作流:先锁定意图,确定是实验还是教程,明确目标、受众和完成标准;再用辅助脚本从模板搭建,避免手写原始 notebook JSON,例如: uv run --python 3.12 python "$JUPYTER_NOTEBOOK_CLI" --kind experiment --title "Compare prompt variants" --out output/jupyter-notebook/compare-prompt-variants.ipynb uv run --python 3.12 python "$JUPYTER_NOTEBOOK_CLI" --kind tutorial --title "Intro to embeddings" --out output/jupyter-notebook/intro-to-embeddings.ipynb 随后用可运行的小步骤填充,每个代码单元格聚焦一步,并用简短 markdown 单元格说明目的与预期结果,避免冗长噪声输出。
模式参考:实验遵循 references/experiment-patterns.md;教程遵循 references/tutorial-patterns.md。编辑已有笔记本时保留结构,除非能改善自上而下的叙事,否则不要重排单元格,优先做定向修改而非整体重写;若必须编辑原始 JSON,先阅读 references/notebook-structure.md。最后进行验证:环境允许时自上而下运行笔记本;无法执行则明确说明并指出本地验证方式,并使用 references/quality-checklist.md 的最终检查清单。
模板与约定:模板位于 assets/experiment-template.ipynb 和 assets/tutorial-template.ipynb;辅助脚本会加载模板、更新标题单元格并写出笔记本,脚本路径为 $JUPYTER_NOTEBOOK_CLI。中间文件放在 tmp/jupyter-notebook/ 并完成后删除;最终产物放在 output/jupyter-notebook/,文件名应稳定且具描述性。依赖方面优先使用 uv;本地执行可选安装 uv pip install jupyterlab ipykernel;捆绑的搭建脚本仅使用 Python 标准库,无需额外依赖。无必需环境变量。
限制:执行能力取决于本地环境,无法运行时须明确说明;收费、价格、平台支持等信息资料暂未提供。