Obsidian Wiki 安裝與設定筆記

Source GitHub：https://github.com/Ar9av/obsidian-wiki

快速安裝（貼心 Script）

Gist：https://gist.github.com/mike840609/78bd19140157e26a7f3567d75868655d

手動安裝

建議使用目前的 Python 執行 pip，避免 pip3 與 python3 指向不同環境：

python3 -m pip install --user -U obsidian-wiki

將 Python 使用者安裝目錄加入 zshrc 或 bashrc：

echo 'export PATH="$(python3 -m site --user-base)/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

確認指令可用：

obsidian-wiki --help

檢查執行檔位置

ls "$(python3 -m site --user-base)/bin/obsidian-wiki"

也可以直接用完整路徑執行：

"$(python3 -m site --user-base)/bin/obsidian-wiki" --help

初始化 obsidian-wiki

obsidian-wiki setup --vault "/你的/Obsidian/Vault/路徑"

例如：

obsidian-wiki setup --vault "$HOME/Documents/MyVault"

設定檔位置

使用 pip 安裝與執行 setup 後，主要設定檔位於：

~/.obsidian-wiki/config

查看設定：

cat ~/.obsidian-wiki/config

編輯設定：

vim ~/.obsidian-wiki/config

設定內容通常類似：

OBSIDIAN_VAULT_PATH="/你的/Obsidian/Vault"
OBSIDIAN_WIKI_REPO="..."
OBSIDIAN_WIKI_VERSION="..."

`.env` 檔案

使用 pip 安裝時不會自動建立 .env。此工具主要讀取 ~/.obsidian-wiki/config；專案中的 .env.example 只是環境變數範本。

若其他腳本需要 .env，可在目前專案目錄建立並加入 Vault 路徑：

touch .env
echo 'OBSIDIAN_VAULT_PATH="/你的/Obsidian/Vault"' >> .env

如果是從 GitHub clone 專案，可用範本建立後再編輯：

cp .env.example .env
vim .env

常用指令

obsidian-wiki info      # 查看安裝資訊
obsidian-wiki doctor    # 檢查設定與安裝狀態
obsidian-wiki list      # 列出內建 skills
obsidian-wiki query "rate limiting"   # 查詢 Wiki
obsidian-wiki lint      # 檢查 Wiki 連結與 metadata

最短完整安裝流程

python3 -m pip install --user -U obsidian-wiki

echo 'export PATH="$(python3 -m site --user-base)/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

obsidian-wiki setup --vault "/你的/Obsidian/Vault/路徑"

obsidian-wiki doctor

除錯指令

python3 -m pip show obsidian-wiki                       # 確認套件是否安裝
python3 -m pip show obsidian-wiki | grep Location        # 查看 pip 套件安裝位置
python3 -m site --user-base                               # 查看使用者安裝根目錄
which obsidian-wiki                                       # 確認 shell 找到哪一個指令
echo "$PATH" | tr ':' '\n'                                 # 查看目前 $PATH