Quick Reference
Quick reference guide and cheat sheet for vsync commands and common patterns.
Commands Overview
| Command | Description | Common Options |
|---|---|---|
init | Initialize configuration | --user |
sync | Synchronize configs | --dry-run, --prune, --user, -y |
plan | Preview sync plan | --user |
status | Check sync status | --user |
list | List configurations | skills, mcp, --user |
clean | Remove from targets | --from-source, --user, -y |
import | Import from project | --user |
Common Workflows
First-Time Setup
# Project-level setup
vsync init
vsync sync
# User-level setup
vsync init --user
vsync sync --userDaily Sync
# 1. Edit configs in source tool
vim ~/.claude/skills/my-skill/SKILL.md
# 2. Sync to targets
vsync syncPreview Before Sync
# Check what will change
vsync plan
# Or use dry-run
vsync sync --dry-run
# If satisfied, apply
vsync syncCleanup Old Configs
# Safe: Remove from targets only
vsync clean skill/old-skill
# Strict mirroring (deletes extras)
vsync sync --pruneSync Modes
Safe Mode (Default)
vsync sync- ✅ Creates new items
- ✅ Updates existing items
- ❌ Never deletes
Prune Mode
vsync sync --prune- ✅ Creates new items
- ✅ Updates existing items
- ⚠️ Deletes items not in source
Configuration Layers
Project-Level
# Default behavior
vsync init # Creates .vsync.json
vsync sync # Syncs project configsUse for: Team configs, project-specific integrations
User-Level
# Add --user flag
vsync init --user # Creates ~/.vsync.json
vsync sync --user # Syncs global configsUse for: Personal preferences, global skills
Command Examples
init
# Project config
vsync init
# User config
vsync init --usersync
# Safe sync
vsync sync
# Prune mode
vsync sync --prune
# Dry run
vsync sync --dry-run
# User-level
vsync sync --user
# Skip confirmation
vsync sync -yplan
# Preview changes
vsync plan
# User-level plan
vsync plan --userstatus
# Check sync status
vsync status
# User-level status
vsync status --userlist
# List all
vsync list
# List skills
vsync list skills
# List MCP servers
vsync list mcp
# User-level
vsync list --userclean
# 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 -yimport
# Import from another project
vsync import ../other-project
# Import to user-level
vsync import ../other-project --userConfig 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"
}Key Settings
| Setting | Values | Description |
|---|---|---|
source_tool | claude-code, cursor, opencode, codex | Your source of truth |
target_tools | Array of tools | Sync destinations |
sync_config.skills | true/false | Enable Skills sync |
sync_config.mcp | true/false | Enable MCP sync |
use_symlinks_for_skills | true/false | Use symlinks (v1.2+) |
language | en/zh | CLI language (user-level only) |
Tool-Specific Formats
MCP Environment Variables
| Tool | Syntax | Example |
|---|---|---|
| Claude Code | ${VAR} | ${API_KEY} |
| Cursor | ${env:VAR} | ${env:API_KEY} |
| OpenCode | {env:VAR} | {env:API_KEY} |
| Codex | No interpolation | Direct value |
Config File Locations
| Tool | Project | User |
|---|---|---|
| Claude Code | .mcp.json | ~/.claude.json |
| Cursor | mcp.json | ~/.cursor/mcp.json |
| OpenCode | opencode.json(c) | ~/.opencode/opencode.json |
| Codex | config.toml | ~/.codex/config.toml |
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 syncCI/CD Integration
# GitHub Actions
- name: Sync configs
run: npx @nicepkg/vsync sync --yesMigration Workflow
# 1. Import from old project
vsync import ../old-project
# 2. Review plan
vsync plan
# 3. Sync to targets
vsync syncExit Codes
| Code | Meaning |
|---|---|
0 | Success |
1 | Error occurred |
Getting Help
# General help
vsync --help
# Command help
vsync sync --help
# Version
vsync --versionCommon Issues
Permission Denied
# Check directory permissions
ls -la ~/.cursor/
# On Windows: Run as Administrator for symlinksConfig Not Found
# Solution: Initialize first
vsync initTool Not Detected
# Solution: Create tool directory
mkdir -p ~/.cursor
vsync initRelated Resources
- Getting Started - Detailed installation guide
- Core Concepts - Understanding vsync
- CLI Commands - Full command reference
- Configuration - Config file details
- Advanced Features - Symlinks, performance
- FAQ - Common questions
- Contributing - Development guide
Last updated on