Obsidian插件之shell commands

Obsidian 插件之 shell commands

shell commands 概念

Basic

Working directory

Working directory 指的是 shell commands 脚本运行的目录，默认是 vault’s 根目录。对应内置变量 ``，在 Environments 可更改：

Environments

执行脚本的环境，内置了一些 shell，也可以自定义 shell。

Preactions

执行 shell command 前的 Prompts，如新建文件时提示用户输入文件名

Output

输出，

Output channels

• Ask after execution：在执行完毕后会弹个模态窗给你选择如何处理 output

• Clipboard： 输出作为文本复制到剪贴板
• Current file: top/bottom/caret position 插入到当前激活的文件；如果没有插入到 message balloon
• Notification/Error balloon: 在 Obsidian 的右上角弹出
• Open files：打开文件
• Status bar：在状态栏输出
• Ignore: 什么也不做
• Assign custom variables：输出作为一个变量；高级用法

Output handling mode

• Wait until finished 等 command 执行完毕后再输出
• Realtime 实时输出

Output wrappers

Output wrappers 用来包裹 shell commands 的 outputs。

• 多个 shell commands 可以共用同一个 output wrapper
• shell commands 可以保持干净，不用写一些 echo
• 在 shell commands 能用的变量，在 output wrappers 中也能用

示例：创建一个 output wrapper，能输出 shell command 执行的时间

Executed on: 
Results:

Events

定义的 shell command 在指定的 events 时机执行

variables

内置变量 built-in variables

参考： - Shell commands documentation - Obsidian Publish

变量名称	说明
``	自动替换为当前 Obsidian Vault 仓库的根目录绝对路径
``	当前文件的绝对路径（如 /Users/name/vault/notes/note.md）
``	当前文件的文件名（如 note.md）
``	当前文件的全文内容（需谨慎使用，内容过长可能导致命令执行失败）
``	当前文件的标题（通常是文件名去掉扩展名，如 note）
``	当前文件的所有标签（逗号分隔，如 #work, #meeting）

自定义变量

• Custom variables - Shell commands documentation - Obsidian Publish

shell commands 应用

• Hexo 博客预览，利用Shell Commands在Obsidian中预览和发布Hexo文章
• 将 Obsidian 文章转换为 Jekyll 格式的文章，并上传到 Github Pages

示例

Obsidian 和 Jekyll

将 Obsidian 文章转化为 Jekyll 格式

实现的目标： 将 ObsidianVault 下的 md 文章转换为符合 Jekyll 格式的文章

shell commands 配置：

• Mac 上的 shell 脚本：

which python3

# 检查 pyyaml 是否安装
if ! pip show pyyaml &> /dev/null; then
  echo "pyyaml 未安装，正在安装…"
  pip install pyyaml
else
  echo "pyyaml 已安装，跳过安装。"
fi

# 检查 argparse 是否安装
if ! pip show argparse &> /dev/null; then
  echo "argparse 未安装，正在安装…"
  pip install argparse
else
  echo "argparse 已安装，跳过安装。"
fi

OBSIDIAN_2_JEKYII=/.obsidian/scripts/python/obsidian2jekyii.py
JEKYLL_BUILD_DIR=$HOME/Documents/build/_posts
OBSIDIAN_VAULT_DIR=

echo "Script path: $OBSIDIAN_2_JEKYII"

echo "start obsidian convert to JekyII _post"

# 检查目录是否存在，如果存在则移除
if [ -d "$JEKYLL_BUILD_DIR" ]; then
  echo "Jekyll directory exists, removing: $JEKYLL_BUILD_DIR"
  rm -rf "$JEKYLL_BUILD_DIR"
fi

# 创建目录
echo "Creating Jekyll directory: $JEKYLL_BUILD_DIR"
mkdir -p "$JEKYLL_BUILD_DIR"

python3 $OBSIDIAN_2_JEKYII --obsidian-dir $OBSIDIAN_VAULT_DIR --jekyll-dir $JEKYLL_BUILD_DIR

# 打开目录
open $JEKYLL_BUILD_DIR

• py 脚本: 位于 ObsidianVault/.obsidian/scripts/python/obsidian2jekyii.py
• 配置 output，stdout 和 stderr 都是询问 脚本执行完毕后输出的 log

Obsidian 转换为 Jekyll，并自动提交

#!/bin/bash

echo "当前时间: $(date "+%Y-%m-%d %H:%M:%S")"

# Obsidian Vault 路径
OBSIDIAN_VAULT_DIR=

# Obsidian 转换脚本路径
obsidian_script=$OBSIDIAN_VAULT_DIR/.obsidian/scripts/python/obsidian2jekyll.py

# GitHub 仓库地址
repo_url="git@github.com:hacket/hacket.github.io.git"

# 本地仓库路径
repo_path="$HOME/Documents/hacket.github.io"

# _posts 目录路径
posts_path="$repo_path/_posts"

# 克隆或拉取仓库
if [ ! -d "$repo_path" ]; then
    echo "正在克隆仓库到 $repo_path…"
    git clone "$repo_url" "$repo_path"
else
    echo "正在更新仓库 $repo_path…"
    git pull --all
fi

# 清空 _posts 目录
echo "正在清空 $posts_path 目录…"
if [ -d "$posts_path" ]; then
  rm -rf "$posts_path"/*
else
  echo "目录 $posts_path 不存在，跳过删除操作。"
fi

# 调用 Obsidian 转换脚本
echo "Obsidian转换Jekyll开始时间: $(date "+%Y-%m-%d %H:%M:%S")"
echo "正在将Obsidian文件转换为 Jekyll 格式…"
# 检查目录是否存在，不存在则创建
if [ ! -d "$posts_path" ]; then
  mkdir -p "$posts_path"
  echo "成功创建目录 $posts_path"
fi
python3 $obsidian_script --obsidian-dir $OBSIDIAN_VAULT_DIR --jekyll-dir $posts_path
echo "Obsidian转换Jekyll结束时间: $(date "+%Y-%m-%d %H:%M:%S")"

pwd

echo "cd 当前仓库路径: $repo_path"
cd $repo_path || exit

# 提交并推送更改
now=$(date "+%Y-%m-%d %H:%M:%S")
message="[Obsidian shell commands]自动化更新 Jekyll 内容 (${now})"
echo "正在提交更改: $message"
git add .
git commit -m "$message"
echo "拉起最新更改…"
git pull origin master
echo "正在推送更改…"
git push origin master

echo "结束时间: $(date "+%Y-%m-%d %H:%M:%S")"
echo "Obsidian转换为Jekyll成功，并提交操作完成!"

配置 Events

在文件或文件夹变更时执行

配合 Commander 配置到 Ribbon 上

• 配合 Commander 在 Ribbon 上配置该命令

Open the current file in vscode and jump to the current position

用 vscode 打开当前文件，并跳转到广播在文章当前位置。

code --goto :

shell commands、Commander、Quick Add 区别

• shell commands：用于调用系统的命令，shell 脚本，py 脚本实现一些功能
• Commander：可将系统命令，自定义的命令在 Ribbon，TabBar，StatusBar 等地方生成图标，直接点击就执行；见 [[Obsidian插件之Commander]]
• Quick Add：能将 Obsidian 内置命令组合成一个新的命令，支持脚本等；见 [[Obsidian插件之QuickAdd]]