# SyncFromGit

**Repository Path**: andershsueh/sync-from-git

## Basic Information

- **Project Name**: SyncFromGit
- **Description**:   1. 插件名称："SyncFromGit"（吉他库库）
  2. 主要功能包括：
    - 在设置中配置GIT URL
  3. 同步机制：以Git仓库作为远程"云盘"，实现多设备间笔记同步
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-18
- **Last Updated**: 2026-01-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SyncFromGit (吉他库库)

一个强大的Obsidian插件，用于通过Git同步您的笔记库，实现多设备间的无缝同步。

## 功能特性

### 1. Git仓库同步
- 支持配置远程Git仓库URL
- 一键同步本地更改到远程仓库
- 支持从远程仓库拉取最新内容

### 2. 文件级同步
- 在文件浏览器中右键菜单增加"提交GIT库"功能
- 可将选定的单个文件或整个目录提交到Git仓库
- 自动执行 `git add`、`git commit` 和 `git push` 操作

### 3. 仓库管理
- 支持从远程Git仓库克隆本地笔记库
- 支持分支切换（使用Obsidian仓库名称作为分支名）
- 从侧边栏进行仓库同步操作

### 4. 多设备支持
- 以Git仓库作为远程"云盘"，实现跨设备笔记同步
- 支持多分支管理（通过对话框选择）

## 技术栈

- **TypeScript**: 类型安全的开发语言
- **Obsidian API**: 利用Obsidian提供的插件API
- **Git**: 版本控制和同步机制
- **Node.js**: 构建和依赖管理

## 安装

1. 下载插件文件到您的Obsidian vault的 `.obsidian/plugins/` 目录
2. 重启Obsidian
3. 在设置中启用插件

## 使用方法

### 配置Git仓库
1. 打开插件设置
2. 输入您的Git仓库URL
3. 保存配置

### 同步文件
1. 在文件浏览器中右键点击文件或文件夹
2. 选择"提交GIT库"
3. 插件将自动将更改推送到远程仓库

### 克隆远程仓库
1. 在侧边栏点击"拉取GIT仓库"按钮
2. 输入Git仓库URL
3. 选择要检出的分支
4. 插件将克隆仓库内容到本地

### 手动同步
1. 在侧边栏使用同步按钮进行手动拉取/推送操作

## 分支策略

- 插件默认使用Obsidian仓库名称作为Git分支名
- 如果仓库包含多个分支，将弹出对话框供用户选择

## 安全性

- 此插件仅对用户有权访问的Git仓库起作用
- 用户需自行确保Git仓库的安全性和访问权限
- 插件不会修改或传输任何敏感认证信息

## 注意事项

- 需要系统已安装Git命令行工具
- Git仓库需要适当的访问权限（如SSH密钥或凭证）
- 建议定期备份重要数据

## 贡献

欢迎提交Issue和Pull Request来改进此插件！

## 许可证

MIT License