背景
为了支持 AI Agent 应用访问本地笔记数据,本文记录利用 Obsidian 配合 GitHub 私有库实现数据同步的配置经验。

环境准备
假设已安装 Obsidian 工具,相关版本如下:
| 类型 | 名称 |
|---|---|
| 操作系统 | macOS (非移动端) |
| Obsidian 版本 | v1.10.6 |
步骤一:下载插件
- 进入 Obsidian 界面,点击左下角设置。

- 开启安全模式(如未开启),点击'浏览插件市场',搜索'git'并确认正确的工具名后安装。



步骤二:配置 Obsidian
注意: 默认电脑已安装 Git 工具。若未安装,请先完成安装。可通过命令行输入 git --version 验证。

2.1 初始化仓库
在 Mac 端输入快捷键 Cmd + P,搜索栏输入 Git: Initialize a new repo 进行初始化。
确认是否初始化完成:输入 Cmd + P,搜索栏输入 Git: Open source control view,出现类似结构说明初始化完成。

2.2 配置 GitHub 关联
- 输入
Cmd + P,搜索栏输入Git: Edit remotes。 Remote name 选origin,url 格式:https://github.com/你的用户名/你的仓库名.git。

- 输入
Cmd + P,搜索栏输入Git: Set upstream branch,选择origin/main,完成主分支设置(只需设置一次)。
2.3 传输文件到 GitHub
方法一:命令行传输
在 Obsidian 输入 Cmd + P,搜索栏输入 Git: Commit all changes。


方法二:手动提交传输


步骤三:配置插件与忽略文件
3.1 进入插件设置

3.2 按需配置
3.3 配置 .gitignore
排除无用文件,保留有价值信息。Mac 端打开 Obsidian,输入 Cmd + P,搜索栏选择下图指令,复制以下代码并保存。


############################# Obsidian - 必须忽略(强烈推荐)#############################
工作区状态(窗口/当前文件/布局,多设备必冲突)
.obsidian/workspace
.obsidian/workspace.json
# 缓存文件(无价值,可再生)
.obsidian/cache/
.obsidian/index.db
.obsidian/index.db-shm
.obsidian/index.db-wal
############################# Obsidian - 可选忽略#############################
同步/发布相关(你不用官方 Sync/Publish 可忽略)
.obsidian/graph.json
.obsidian/appearance.json
############################# 系统垃圾############################
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
############################# 编辑器/临时文件############################
*.tmp
*.temp
*.bak
*.swp
*.swo
############################# 日志############################
*.log

