如何使用nbdiff查看本地与远程分支的Jupyter Notebook差异？

我来帮你搞定这个痛点！nbdiff本身没法直接访问远程Git仓库里的文件，所以你直接用nbdiff file.ipynb origin/<branch_name>/file.ipynb肯定行不通——因为origin/<branch_name>/file.ipynb并不是本地存在的路径，而是Git远程仓库的引用。

下面是靠谱的操作步骤：

• 第一步：拉取远程仓库最新内容
  先确保本地已经同步了远程分支的最新版本，执行：

  git fetch origin
  

• 第二步：导出远程分支的Notebook到本地临时文件
  用git show命令把远程分支上的目标Notebook导出到本地的临时文件中，比如：

  git show origin/<branch_name>:file.ipynb > remote_file.ipynb
  

  这里的<branch_name>替换成你要对比的远程分支名（比如main或dev），remote_file.ipynb是临时存储远程版本的文件名，你可以随便取。

• 第三步：用nbdiff对比本地与远程版本
  现在两个文件都在本地了，直接执行nbdiff命令即可：

  nbdiff file.ipynb remote_file.ipynb
  

  这样就能正常看到两个Notebook之间的单元格差异、代码改动、文本变化等内容了。

• 第四步：清理临时文件（可选）
  对比完成后，记得删掉刚才创建的临时文件：

  rm remote_file.ipynb
  

进阶：自动化对比脚本 #

如果你经常需要做这个操作，可以写一个简单的Shell脚本简化流程，比如创建nbdiff-remote.sh：

#!/bin/bash
# 脚本用法：./nbdiff-remote.sh <本地Notebook路径> <远程分支名> <远程Notebook路径>

if [ $# -ne 3 ]; then
    echo "错误：参数数量不对！"
    echo "用法示例：./nbdiff-remote.sh ./my_notebook.ipynb main ./notebooks/my_notebook.ipynb"
    exit 1
fi

LOCAL_NOTEBOOK=$1
REMOTE_BRANCH=$2
REMOTE_NOTEBOOK_PATH=$3
TEMP_FILE=$(mktemp)  # 创建系统临时文件，避免手动命名

# 导出远程文件到临时文件
git show origin/${REMOTE_BRANCH}:${REMOTE_NOTEBOOK_PATH} > ${TEMP_FILE}

# 执行对比
nbdiff ${LOCAL_NOTEBOOK} ${TEMP_FILE}

# 清理临时文件
rm ${TEMP_FILE}

给脚本加执行权限：

chmod +x nbdiff-remote.sh

之后直接用脚本对比：

./nbdiff-remote.sh file.ipynb main file.ipynb

内容的提问来源于stack exchange，提问作者Tom