Local Snapshots for VS Code

Take and restore snapshots of your workspace files with ease. Local Snapshots provides a powerful way to create, manage, and restore file snapshots directly within VS Code, offering both manual and automatic snapshot capabilities.

Features

📸 Multiple Snapshot Types

• Manual Snapshots: Take named snapshots of your entire workspace
• Quick Snapshots: Quickly capture the current state with a single keystroke
• Pre-Save Snapshots: Automatically create snapshots before saving files
• Timed Snapshots: Set up automatic snapshots at regular intervals
• File/Directory Snapshots: Take snapshots of specific files or directories

🔍 Advanced Snapshot Management

• Visual Diff View: See exactly what changed between snapshots and current files
  • Side-by-side comparison
  • Inline unified view
  • File-by-file navigation
  • Direct file restoration from diff view
  • Search within diffs
  • Previous/Next match navigation
  • Match count indicator
• Tree View: Browse snapshot contents in a hierarchical structure
  • Directory-based file organization
  • Expand/collapse folders
  • Direct file restoration from tree view
  • Visual feedback for restored files
• Ignore Patterns: Exclude files from snapshots
  • Automatic .gitignore integration
  • Custom ignore patterns support
  • Visual pattern management interface
  • Search and filter patterns
  • Add files/folders via context menu
  • Real-time pattern updates
• Selective Restore: Choose specific files to restore from a snapshot
• Snapshot Filtering: Search and filter snapshots by name, date, or file count
• Snapshot Limits: Optionally limit the number of snapshots to manage storage
• Rename Snapshots: Easily rename snapshots with duplicate name validation
• Delete Snapshots: Remove individual snapshots or clear all at once

⚡ Quick Actions

• Context Menu Integration: Right-click files or folders to take snapshots
• Keyboard Shortcuts: Quick access to common actions
  • Take Quick Snapshot: Ctrl+Alt+S (Windows/Linux) or Cmd+Alt+S (Mac)
  • Restore Snapshot: Ctrl+Alt+R (Windows/Linux) or Cmd+Alt+R (Mac)

Getting Started

1. Install the extension from the VS Code marketplace
2. Access Local Snapshots from the activity bar (look for the snapshot icon)
3. Take your first snapshot using the "Take Named Snapshot" button
4. View and manage your snapshots in the sidebar
5. Configure the extension using the custom settings page (click the gear icon in the sidebar)

Extension Settings

Automatic Snapshots

• local-snapshots.enablePreSaveSnapshots: Enable/disable automatic snapshots before saving files (default: false)
• local-snapshots.enableTimedSnapshots: Enable/disable automatic snapshots at regular intervals (default: false)
• local-snapshots.timedSnapshotInterval: Set the interval between automatic snapshots in seconds (default: 300, minimum: 30)
• local-snapshots.showTimedSnapshotNotifications: Show notifications when timed snapshots are created (default: true)
• local-snapshots.skipUnchangedSnapshots: Skip creating snapshots when no files have changed, applies to both automatic and manual snapshots (default: false)

Storage Management

• local-snapshots.limitSnapshotCount: Enable/disable maximum snapshot limit (default: false)
• local-snapshots.maxSnapshotCount: Maximum number of snapshots to keep (default: 10, minimum: 1)
• local-snapshots.respectGitignore: Use .gitignore patterns to exclude files from snapshots (default: true)
• local-snapshots.customIgnorePatterns: Custom glob patterns to exclude files from snapshots (e.g. ['*.log', 'temp/**'])

Display Settings

• local-snapshots.diffViewStyle: Choose how to display file differences: side-by-side, inline, or both views (default: side-by-side)

Server Settings

• local-snapshots.enableApiServer: Enable/disable the REST API server (default: false)
• local-snapshots.enableMcpServer: Enable/disable the MCP (Model Context Protocol) SSE server (default: false)

Note: Ports are now managed automatically. The extension will try to use default ports (45678 for API, 45679 for MCP) first, and if they're in use, it will automatically find an available port.

Usage Tips

Using the MCP Server

The extension can expose a Model Context Protocol (MCP) server for AI tool integration. This allows AI tools like Cursor AI to create and manage snapshots directly. To use it:

1. Enable the MCP server in settings: localSnapshots.enableMcpServer
2. The MCP status and actual port will be shown in the status bar
3. You can also see the connection URL in the custom settings page under the MCP Server tab
4. Connect your MCP-compatible client (like Cursor AI) to the server using the displayed URL

Available MCP Tools

• takeNamedSnapshot: Create a named snapshot of the current workspace
  • Parameters: name (string) - Name for the snapshot

MCP Client Configuration Example (Cursor AI)

{
  "mcpServers": {
    "local-snapshots": {
      "transport": "sse",
      "url": "http://localhost:PORT/sse"
    }
  }
}

Note: Replace PORT with the actual port shown in the status bar or settings page. The port may vary if the default port (45679) is already in use.

Using the REST API

The extension can expose a simple REST API for programmatic snapshot creation. To use it:

1. Enable the API server in settings: localSnapshots.enableApiServer
2. The API status and actual port will be shown in the status bar
3. You can also see the connection URL and example usage in the custom settings page under the API Server tab
4. Create snapshots using HTTP requests using the displayed port:

PowerShell Examples

# Using Invoke-RestMethod (recommended)
# Replace PORT with the actual port shown in the status bar or settings page
$port = "PORT" # e.g., 45678 or whatever port is shown in the UI
$body = @{
    name = "Pre-AI-Changes"
} | ConvertTo-Json

Invoke-RestMethod `
    -Method Post `
    -Uri "http://localhost:$port/snapshot" `
    -Body $body `
    -ContentType "application/json"

# List all snapshots
Invoke-RestMethod -Method Get -Uri "http://localhost:$port/snapshots"

# Check API health
Invoke-RestMethod -Method Get -Uri "http://localhost:$port/health"

Curl Examples

# Replace PORT with the actual port shown in the status bar or settings page

# Create a snapshot (Windows PowerShell)
$port = "PORT" # e.g., 45678 or whatever port is shown in the UI
curl.exe -X POST http://localhost:$port/snapshot `
  -H "Content-Type: application/json" `
  -d "{\"name\":\"Pre-AI-Changes\"}"

# Create a snapshot (Unix/Git Bash)
PORT=PORT # e.g., 45678 or whatever port is shown in the UI
curl -X POST http://localhost:$PORT/snapshot \
  -H "Content-Type: application/json" \
  -d '{"name":"Pre-AI-Changes"}'

# List all snapshots
curl http://localhost:$PORT/snapshots

# Check API health
curl http://localhost:$PORT/health

API Endpoints

• POST /snapshot: Create a new snapshot
  • Body: { "name": "snapshot-name" }
  • Response: { "success": true, "message": "..." }
• GET /snapshots: List all snapshots
  • Response: { "success": true, "snapshots": [...] }
• GET /health: Check API status
  • Response: { "status": "ok" }

Error Handling

The API returns detailed error messages in JSON format:

{
    "error": "Error type",
    "details": "Detailed error message"
}

Common error codes:

• 400: Bad Request (invalid JSON or missing fields)
• 404: Endpoint not found
• 500: Server error (snapshot operation failed)

If the default port is already in use, the extension will:

• Automatically find an available port
• Show a notification with the alternate port being used
• Update the status bar and settings page with the actual port

Taking Snapshots

• Use named snapshots for important changes or milestones
• Use quick snapshots for rapid iterations
• Enable pre-save snapshots when working on critical changes
• Set up timed snapshots during intensive development sessions

Managing Snapshots

• Use the filter panel to quickly find specific snapshots
• View diffs before restoring to verify changes
• Use selective restore to recover specific files
• Clean up old snapshots regularly using the snapshot limit feature
• Rename snapshots to keep them organized and meaningful

Using the Custom Settings Page

• Access the settings page by clicking the gear icon in the Local Snapshots sidebar
• Navigate between tabs to configure different aspects of the extension
• The General tab contains basic settings like automatic snapshots and storage management
• The Snapshots tab has settings for snapshot behavior and display
• The API Server tab provides configuration and usage examples for the REST API
• The MCP Server tab offers settings and connection information for the MCP server
• Real-time server status and port information is displayed in the respective tabs
• All changes are immediately saved to your VS Code settings

Managing Ignore Patterns

• Access the ignore patterns manager from the Local Snapshots sidebar
• Patterns from .gitignore files are automatically synced and marked
• Add custom patterns using the input field or context menu
• Right-click files/folders in VS Code explorer to add them to ignore patterns
• Use the search boxes to filter both patterns and workspace files
• Custom patterns can be removed, while .gitignore patterns are read-only
• Changes take effect immediately for future snapshots

Keyboard Shortcuts

Create your own keyboard shortcuts for any of these commands:

• local-snapshots.takeSnapshot: Take a named snapshot
• local-snapshots.quickSnapshot: Take a quick snapshot
• local-snapshots.restoreSnapshot: Restore a snapshot
• local-snapshots.snapshotFile: Take a snapshot of the current file
• local-snapshots.snapshotDirectory: Take a snapshot of a directory

Requirements

• VS Code version 1.74.0 or higher
• No additional dependencies required

Known Issues & Feedback

Please report any issues or feature suggestions by creating a new issue on our GitHub Issues page. Also, if you enjoy using the extension, please consider giving the repository a star on GitHub to show your support!

Release Notes

See our CHANGELOG.md for detailed release notes.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This extension is licensed under the MIT License.

Enjoy using Local Snapshots!