Prompt Vault Extension

Automatically sync GitHub Copilot prompts from multiple Git repositories to your local VS Code environment.

🎯 Overview

The Prompts Sync Extension automatically synchronizes the latest GitHub Copilot prompts, instructions, and templates from one or more Git repositories to your local VS Code user prompts directory. This ensures you always have access to the most up-to-date, peer-reviewed prompts across all your projects from multiple sources.

✨ Features

• 🔄 Automatic Sync: Configurable sync frequency (daily by default)
• 📦 Multiple Repositories: Support for syncing from multiple Git repositories simultaneously
• 🌍 Cross-Platform: Works on macOS, Windows, and Linux
• ⚙️ Configurable: Customizable sync frequency and target directory
• 🔐 Secure: Uses your existing GitHub authentication from VS Code
• 📦 Read-Only: Safe pull-only synchronization (no risk of overwriting repositories)
• 🎨 User-Friendly: Simple setup with minimal configuration required
• 📊 Status Indicators: Clear feedback on sync status and last update time
• 🛡️ Error Handling: Graceful handling of repository conflicts and partial failures

🚀 Quick Start

Prerequisites

• VS Code 1.70.0 or higher
• GitHub authentication configured in VS Code
• Access to a git repository with prompts and configuration files

Installation

1. Download the latest prompt-vault-extension.vsix file from the releases
2. Open VS Code
3. Press Ctrl+Shift+P (or Cmd+Shift+P on macOS) to open the command palette
4. Type "Extensions: Install from VSIX" and select it
5. Browse and select the downloaded .vsix file
6. Restart VS Code when prompted

First-Time Setup

1. Open VS Code Settings (Ctrl+, or Cmd+,)
2. Search for "Prompt Vault"
3. Configure your preferences (optional - defaults work for most users)
4. The extension will automatically perform an initial sync

⚙️ Configuration

Extension Settings

Sync Frequency Options

• "startup" - Only sync when VS Code starts
• "hourly" - Sync every hour
• "daily" - Sync once per day (default)
• "weekly" - Sync once per week
• "manual" - Only sync when manually triggered

Default Prompts Directory Paths

The extension automatically detects the correct prompts directory for your operating system:

• macOS: ~/Library/Application Support/Code/User/prompts
• Windows: %APPDATA%\Code\User\prompts
• Linux: ~/.config/Code/User/prompts

You can override this by setting a custom path in promptVault.customPath.

Multiple Repository Configuration

The extension supports syncing from multiple Git repositories simultaneously. This is useful for organizations that maintain prompt collections across multiple repositories or for users who want to combine prompts from different sources.

Setting up Multiple Repositories

1. Using VS Code Settings UI:

   • Open Settings (Ctrl+, or Cmd+,)
   • Search for "promptVault.repositories"
   • Click "Add Item" to add each repository URL

2. Using JSON Configuration:

   {
     "promptVault.repositories": [
       "https://github.com/your-org/prompts-main",
       "https://github.com/your-org/prompts-experimental",
       "https://github.com/another-org/shared-prompts"
     ]
   }
   

Error Handling

When syncing multiple repositories:

• Partial Success: If some repositories sync successfully while others fail, the extension shows a partial success notification with details
• Complete Failure: If all repositories fail, an error notification is shown
• Individual Errors: Repository-specific errors are logged and reported separately

🎮 Usage

Automatic Sync

Once configured, the extension works automatically based on your sync frequency setting. You'll see notifications (if enabled) when sync operations complete.

Manual Sync

You can manually trigger a sync at any time:

1. Open the command palette (Ctrl+Shift+P or Cmd+Shift+P)
2. Type "Prompts Sync: Sync Now"
3. Press Enter

Status Bar

The extension adds a status bar item showing:

• Sync status (✅ synced, 🔄 syncing, ❌ error)
• Last sync time
• Click to manually trigger sync

View Sync Status

Check detailed sync information:

1. Open the command palette
2. Type "Prompts Sync: Show Status"
3. View sync history, errors, and configuration details

📁 Synced Content

The extension syncs all prompt files from the repository subdirectories into a flattened structure:

prompts/chatmode/*.md       → User/prompts/
prompts/instructions/*.md   → User/prompts/
prompts/prompt/*.md         → User/prompts/

All files are placed directly in the User/prompts/ directory, removing any subfolder structure for easier access and organization.

🔧 Troubleshooting

Common Issues

Sync Fails with Authentication Error

Problem: Extension can't access the GitHub repository

Solutions:

1. Ensure you're signed into GitHub in VS Code (View > Command Palette > GitHub: Sign In)
2. Verify you have access to the repository
3. Check your internet connection

Prompts Directory Not Found

Problem: Extension can't find or create the prompts directory

Solutions:

1. Ensure VS Code has write permissions to the user directory
2. Manually create the prompts directory if it doesn't exist
3. Set a custom path in extension settings

Sync Takes Too Long

Problem: Sync operation seems stuck

Solutions:

1. Check your internet connection
2. Try manual sync to see detailed error messages
3. Restart VS Code and try again

Debug Mode

Enable debug logging:

1. Open VS Code Settings
2. Search for "promptVault.debug"
3. Enable debug mode
4. Check the "Prompts Sync" output channel for detailed logs

🔒 Security & Privacy

• Read-Only Access: The extension only pulls content from the repository
• No Data Collection: No usage data or personal information is collected
• GitHub Authentication: Uses VS Code's built-in GitHub authentication
• Local Storage: All prompts are stored locally on your machine
• No Network Requests: Only communicates with GitHub for repository access

🛠️ Development

Building from Source

# Clone the repository
git clone https://github.com/MounirAbdousNventive/prompts-logient-nventive.git
cd prompts-logient-nventive/tools/vscode-extension

# Install dependencies
npm install

# Build the extension
npm run compile

# Package the extension
npm run package

Project Structure

tools/vscode-extension/
├── src/
│   ├── extension.ts          # Main extension entry point
│   ├── syncManager.ts        # Sync logic and GitHub integration
│   ├── configManager.ts      # Configuration management
│   ├── statusBarManager.ts   # Status bar integration
│   └── utils/
│       ├── fileSystem.ts     # File system operations
│       ├── github.ts         # GitHub API wrapper
│       └── notifications.ts  # User notifications
├── package.json              # Extension manifest
├── tsconfig.json            # TypeScript configuration
├── webpack.config.js        # Build configuration
└── README.md               # This file

Scripts

• npm run compile - Build the extension
• npm run watch - Build in watch mode
• npm run package - Create VSIX package
• npm run test - Run tests
• npm run lint - Run ESLint

🤝 Contributing

We welcome contributions to improve the extension! Please see our Contribution Guide for details.

Reporting Issues

1. Check existing issues in the repository
2. Create a new issue with:
   • Extension version
   • VS Code version
   • Operating system
   • Detailed description of the problem
   • Steps to reproduce

Feature Requests

1. Open an issue with the "enhancement" label
2. Describe the desired functionality
3. Explain the use case and benefits

📋 Changelog

Version 1.2.0 (Multiple Repository Support)

• ✅ New Feature: Support for syncing from multiple Git repositories
• ✅ Added promptVault.repositories array setting for multiple repository URLs
• ✅ Enhanced error handling for repository conflicts and failures
• ✅ Improved status display showing multi-repository sync results
• ✅ Graceful handling of partial sync success scenarios
• ✅ Backward compatibility with single repository configuration
• ✅ Updated documentation with multi-repository setup instructions

Version 1.1.0 (Selective Sync & Flattened Structure)

• ✅ New Feature: Selective sync settings for different prompt types
• ✅ Added promptVault.syncChatmode setting (default: true)
• ✅ Added promptVault.syncInstructions setting (default: true)
• ✅ Added promptVault.syncPrompt setting (default: true)
• ✅ Flattened folder structure - all files sync directly to User/prompts/
• ✅ Enhanced status display showing selected sync types
• ✅ Improved configurability and user control

Version 1.0.0 (Initial Release)

• ✅ Basic sync functionality
• ✅ Configurable sync frequency
• ✅ Cross-platform support
• ✅ GitHub authentication integration
• ✅ Status bar integration
• ✅ User notifications
• ✅ Manual sync commands

📄 License

Internal use only - Logient/Nventive Development Team

📞 Support

For support and questions:

• Check the troubleshooting section above
• Report an issue.

Made with ❤️ by the Logient-Nventive DevOps Team