Skip to Content
🚀 vsync v1.0 is here! Sync your AI tools effortlessly. Star us on GitHub
DocumentationQuick Reference

Quick Reference

Quick reference guide and cheat sheet for vsync commands and common patterns.

Commands Overview

CommandDescriptionCommon Options
initInitialize configuration--user
syncSynchronize configs--dry-run, --prune, --user, -y
planPreview sync plan--user
statusCheck sync status--user
listList configurationsskills, mcp, --user
cleanRemove from targets--from-source, --user, -y
importImport from project--user

Common Workflows

First-Time Setup

# Project-level setup vsync init vsync sync # User-level setup vsync init --user vsync sync --user

Learn more →

Daily Sync

# 1. Edit configs in source tool vim ~/.claude/skills/my-skill/SKILL.md # 2. Sync to targets vsync sync

Preview Before Sync

# Check what will change vsync plan # Or use dry-run vsync sync --dry-run # If satisfied, apply vsync sync

Cleanup Old Configs

# Safe: Remove from targets only vsync clean skill/old-skill # Strict mirroring (deletes extras) vsync sync --prune

Learn more →

Sync Modes

Safe Mode (Default)

vsync sync
  • ✅ Creates new items
  • ✅ Updates existing items
  • ❌ Never deletes

Learn more →

Prune Mode

vsync sync --prune
  • ✅ Creates new items
  • ✅ Updates existing items
  • ⚠️ Deletes items not in source

Learn more →

Configuration Layers

Project-Level

# Default behavior vsync init # Creates .vsync.json vsync sync # Syncs project configs

Use for: Team configs, project-specific integrations

User-Level

# Add --user flag vsync init --user # Creates ~/.vsync.json vsync sync --user # Syncs global configs

Use for: Personal preferences, global skills

Learn more →

Command Examples

init

# Project config vsync init # User config vsync init --user

sync

# Safe sync vsync sync # Prune mode vsync sync --prune # Dry run vsync sync --dry-run # User-level vsync sync --user # Skip confirmation vsync sync -y

plan

# Preview changes vsync plan # User-level plan vsync plan --user

status

# Check sync status vsync status # User-level status vsync status --user

list

# List all vsync list # List skills vsync list skills # List MCP servers vsync list mcp # User-level vsync list --user

clean

# Remove single item from targets vsync clean skill/old-skill # Interactive selection vsync clean # Delete from source too (DANGEROUS!) vsync clean skill/old-skill --from-source # User-level vsync clean --user # Skip confirmation vsync clean skill/old-skill -y

Learn more →

import

# Import from another project vsync import ../other-project # Import to user-level vsync import ../other-project --user

Config File Quick Reference

.vsync.json

{ "version": "1.0.0", "level": "project", "source_tool": "claude-code", "target_tools": ["cursor", "opencode", "codex"], "sync_config": { "skills": true, "mcp": true }, "use_symlinks_for_skills": false, "language": "en" }

Learn more →

Key Settings

SettingValuesDescription
source_toolclaude-code, cursor, opencode, codexYour source of truth
target_toolsArray of toolsSync destinations
sync_config.skillstrue/falseEnable Skills sync
sync_config.mcptrue/falseEnable MCP sync
use_symlinks_for_skillstrue/falseUse symlinks (v1.2+)
languageen/zhCLI language (user-level only)

Tool-Specific Formats

MCP Environment Variables

ToolSyntaxExample
Claude Code${VAR}${API_KEY}
Cursor${env:VAR}${env:API_KEY}
OpenCode{env:VAR}{env:API_KEY}
CodexNo interpolationDirect value

Learn more →

Config File Locations

ToolProjectUser
Claude Code.mcp.json~/.claude.json
Cursormcp.json~/.cursor/mcp.json
OpenCodeopencode.json(c)~/.opencode/opencode.json
Codexconfig.toml~/.codex/config.toml

Learn more →

Common Patterns

Team Collaboration

# 1. Commit config to git git add .vsync.json git commit -m "feat: add vsync config" # 2. Team members clone and sync git clone <repo> cd <repo> vsync sync

CI/CD Integration

# GitHub Actions - name: Sync configs run: npx @nicepkg/vsync sync --yes

Learn more →

Migration Workflow

# 1. Import from old project vsync import ../old-project # 2. Review plan vsync plan # 3. Sync to targets vsync sync

Learn more →

Exit Codes

CodeMeaning
0Success
1Error occurred

Getting Help

# General help vsync --help # Command help vsync sync --help # Version vsync --version

Common Issues

Permission Denied

# Check directory permissions ls -la ~/.cursor/ # On Windows: Run as Administrator for symlinks

Config Not Found

# Solution: Initialize first vsync init

Tool Not Detected

# Solution: Create tool directory mkdir -p ~/.cursor vsync init

More troubleshooting →

Last updated on