快速开始
只需几分钟即可开始使用 vsync。
安装
vsync 可以通过 npx 直接使用无需安装，也可以全局安装以便使用。
方式 1：使用 npx 运行（推荐）
无需安装——直接运行：
npx @nicepkg/vsync方式 2：全局安装
npm install -g @nicepkg/vsync验证安装：
vsync --version快速开始
1. 初始化配置
导航到您的项目目录并运行：
vsync init对于全局用户级配置：
vsync init --user💡 提示：在核心概念中了解更多关于项目层与用户层的信息。
交互式设置
CLI 将引导您完成设置过程：
🚀 欢迎使用 vsync！
✔ 检测现有工具...
✔ 已检测到: claude-code, cursor
? 您使用哪些 AI 氛围编程工具？
◉ claude-code (已检测到)
◉ cursor (已检测到)
◯ opencode
◯ codex
? 哪个工具是您的配置源？
❯ claude-code
? 您想同步什么？
◉ Skills
◉ MCP
✔ 配置文件已创建
✔ 缓存目录已创建
✔ Manifest 已初始化
✅ 设置完成！运行 vsync sync 开始同步📚 了解更多：查看配置指南了解详细配置选项。
2. 同步您的配置
初始化完成后，同步您的配置：
# Safe 模式（默认：不删除）
vsync sync
# 预览更改而不应用
vsync sync --dry-run
# 严格镜像（删除目标中的额外项）
vsync sync --prune🔍 详情：在核心概念中理解同步模式。
理解输出
当您运行 vsync sync 时，您将看到详细的计划：
📖 正在读取源配置 (claude-code)...
✓ 找到 3 个技能
✓ 找到 2 个 MCP 服务器
📊 分析差异...
📋 同步计划 (Safe 模式)
cursor:
CREATE:
• skill/deploy-prod
UPDATE:
• skill/git-release
• mcp/github
SKIP:
• skill/api-conventions (未更改)
• mcp/sqlite (未更改)
? 继续同步？ (Y/n) y
✓ 同步完成，耗时 1.2s下一步
现在您已经安装并初始化了 vsync：
实际示例
团队新成员入职
新团队成员加入，已经设置好 Claude Code：
cd my-project
vsync init # 选择 Claude Code 作为源，Cursor 和 OpenCode 作为目标
vsync sync # 所有工具立即配置完成！用户级配置同步
一次设置全局个人配置，随处使用：
vsync init --user # 配置要同步哪些工具
vsync sync --user # 全局同步个人 Skills、MCP 服务器💡 相关：了解配置层级。
工具间迁移
从 Cursor 迁移到 Claude Code：
vsync init # 选择 Cursor 作为 SOURCE（参考标准）
# 选择 Claude Code 作为 TARGET（将从源同步）
vsync sync # 所有配置立即迁移！📖 更多信息：查看 FAQ - 迁移问题。
故障排除
找不到配置文件
如果您看到”找不到配置文件”，请先运行 vsync init 创建配置。
未检测到工具
确保工具的配置目录存在（例如，.claude/、.cursor/）在您的项目或主目录中。
权限错误
在 macOS/Linux 上，您可能需要授予文件操作权限。检查您是否具有目标目录的写入权限。
🔧 更多帮助：查看 FAQ 获取详细的故障排除。
获取帮助
Last updated on