Skip to content

AmadeusITGroup/prompt-registry

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

8 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

🎨 Prompt Registry

A visual marketplace for discovering, installing, and managing GitHub Copilot prompt libraries from multiple sources.

VS Code Marketplace License Version


πŸ“‹ Table of Contents


🌟 Overview

Prompt Registry transforms how you discover and manage GitHub Copilot prompts. Instead of manually copying prompt files or cloning repositories, browse a visual marketplace, search by tags, and install curated prompt libraries with a single click.

Prompty Registry - main views

Why Prompt Registry?

  • 🎯 Discover - Browse curated prompt collections from multiple sources
  • ⚑ Install - One-click installation with automatic Copilot sync
  • πŸ”„ Manage - Update, organize, and uninstall bundles easily
  • πŸ‘₯ Share - Create and distribute your own prompt libraries
  • 🌍 Multi-Platform - Works on macOS, Linux, and Windows

✨ Features

🎨 Visual Marketplace

Browse prompt bundles in a modern, tile-based interface inspired by VS Code's extension marketplace:

  • Rich Metadata: See descriptions, tags, content breakdown, and installation status
  • Search & Filter: Find prompts by keywords, tags, or content type
  • Content Preview: View detailed information before installing
  • One-Click Install: Install bundles instantly from the marketplace

πŸ”Œ Multi-Source Support

Connect to various prompt sources:

Source Type Description Use Case
Awesome Copilot Curated community collections Discover popular prompts
Local Awesome Copilot Local awesome-copilot collections Develop/test collections locally
GitHub Direct from GitHub repositories Team/project-specific prompts
GitLab GitLab repositories and releases Enterprise GitLab users
HTTP Any HTTP/HTTPS URL Custom hosting
Local File system directories Private/offline prompts

πŸ“¦ Bundle Management

  • Install/Uninstall: Manage bundles through UI or commands
  • Version Control: Track installed versions
  • Auto-Sync: Automatic synchronization with GitHub Copilot
  • Conflict Resolution: Handle duplicate bundles gracefully

πŸ‘₯ Profile Management

Organize prompts by project, team, or environment:

Work Projects Profile
  β”œβ”€β”€ testing-automation (v1.0.0)
  β”œβ”€β”€ code-review (v2.1.0)
  └── api-documentation (v1.5.0)

Personal Profile
  β”œβ”€β”€ creative-writing (v1.0.0)
  └── learning-resources (v0.9.0)

βš™οΈ Settings Management

Export and import your entire Prompt Registry configuration:

  • πŸ“€ Export - Save sources, profiles, and settings to JSON/YAML
  • πŸ“₯ Import - Restore configuration with merge or replace strategies
  • πŸ”„ Backup - Keep configuration safe before changes
  • πŸ‘₯ Share - Distribute team configurations easily
  • πŸ’Ύ Version Control - Track settings in Git with YAML format

🌍 Cross-Platform

Automatically detects and uses the correct directories:

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

Supports all VS Code flavors: Stable, Insiders, and Windsurf.


πŸ“¦ Installation

From VS Code Marketplace

  1. Open VS Code
  2. Press Ctrl+Shift+X (or Cmd+Shift+X on macOS)
  3. Search for "Prompt Registry"
  4. Click Install

From VSIX

# Download the latest .vsix file
code --install-extension prompt-registry-2.0.0.vsix

From Source

git clone https://github.com/AmadeusITGroup/prompt-registry.git
cd prompt-registry
npm install
npm run compile
code --install-extension .

πŸš€ Quick Start

1. Add a Source

First, add a prompt source to the registry:

Ctrl+Shift+P β†’ "Prompt Registry: Add Source"

Choose a source type:

  • Awesome Copilot Collection - Pre-configured curated prompts
  • GitHub Repository - Enter repository URL
  • Local Directory - Select a folder

2. Browse the Marketplace

Open the Prompt Registry Marketplace:

Click "MARKETPLACE" in the Prompt Registry sidebar

Or use the command:

Ctrl+Shift+P β†’ "Prompt Registry: Open Marketplace"

3. Install a Bundle

Click on any bundle tile to view details, then click Install.

Your prompts are now available in GitHub Copilot! πŸŽ‰


πŸ“– Usage

Browsing the Marketplace

The marketplace provides multiple ways to discover prompts:

Search

Type in the search box to filter by:
- Bundle name
- Description keywords
- Tags

Filter by Content Type

Click filter buttons to show only:
- Prompts
- Instructions
- Chat Modes
- Agents

View Details

Click on any bundle tile to see:
- Full description
- Content breakdown (prompts, instructions, etc.)
- Installation information
- Tags and metadata
- List of included files

Installing Bundles

From Marketplace

  1. Browse - Find a bundle in the marketplace
  2. Review - Click the tile to view details
  3. Install - Click the Install button
  4. Verify - Check the installed badge appears

From Tree View

  1. Navigate - Go to Registry Explorer in sidebar
  2. Find - Locate a bundle under a source
  3. Install - Right-click β†’ "Install Bundle"

From Command Palette

Ctrl+Shift+P β†’ "Prompt Registry: Install Bundle"
# Select source β†’ Select bundle β†’ Confirm

Managing Sources

Add Source

Ctrl+Shift+P β†’ "Prompt Registry: Add Source"

Awesome Copilot Collection (Recommended for beginners):

  • Pre-configured
  • Curated community prompts
  • Automatically updated

GitHub Repository:

  • Repository URL: https://github.com/owner/repo
  • Branch: main (optional)
  • Collections Path: collections (optional)

Local Directory:

  • Select a folder containing deployment-manifest.yml

Edit Source

Right-click source in tree view β†’ "Edit Source"

🎨 Creating Prompt Projects

Scaffold Command

Quickly create a new GitHub Copilot prompt project with proper structure:

Ctrl+Shift+P β†’ "Prompt Registry: Scaffold Awesome Copilot Project"

The scaffold will create:

  • Prompts - Sample prompt files
  • Instructions - Getting started guides
  • Chat Modes - Conversation configurations
  • Collections - Organized prompt collections
  • Workflows - Validation scripts
  • Documentation - README and best practices

Project Types

Type Description Status
Awesome Copilot Full-featured template with all resource types βœ… Available
Basic Minimal template for quick starts πŸ”œ Coming Soon
Enterprise Advanced template with governance πŸ”œ Coming Soon

Collection Validation

Validate your collections against the schema:

Ctrl+Shift+P β†’ "Prompt Registry: Validate Collections"

Features:

  • βœ… JSON Schema Validation - Ensures proper structure
  • πŸ” File Reference Checking - Verifies all files exist
  • ⚠️ Best Practice Warnings - Helpful suggestions
  • πŸ“Š Detailed Reports - Clear error messages

Learn more in the Scaffolding and Validation Guide.

Remove Source

Right-click source in tree view β†’ "Remove Source"

Working with Profiles

Profiles help organize bundles by project, team, or environment.

Create Profile

Ctrl+Shift+P β†’ "Prompt Registry: Create Profile"
# Enter profile name (e.g., "Work Projects")

Install to Profile

When installing a bundle:
1. Choose "Profile" scope
2. Select target profile
3. Bundle installs only to that profile

Switch Profile

Ctrl+Shift+P β†’ "Prompt Registry: Switch Profile"
# Select active profile

View Profile Contents

Sidebar β†’ "My Profiles" β†’ Select profile
# See all bundles in that profile

Using Registry Explorer

The Registry Explorer sidebar provides a comprehensive view of your Prompt Registry ecosystem.

Overview

Access via the sidebar icon or:

Ctrl+Shift+P β†’ "View: Show Prompt Registry Explorer"

Features

πŸ“¦ Installed Bundles

  • View all installed bundles by scope (User/Workspace)
  • Right-click for actions: View Details, Update, Uninstall, Check Updates
  • See installation status and version information

πŸ‘₯ My Profiles

  • Manage profile-based installations
  • Right-click for actions: Activate, Edit, Export, Delete
  • Quick profile switching

πŸ“‘ Sources

  • View all configured sources with priority and status
  • Right-click context menu for quick actions:
    • Edit Source - Modify configuration, change priority, toggle enabled/disabled
    • Sync Source - Refresh bundle listings from source
    • Toggle Enabled/Disabled - Quick enable/disable without editing
    • Remove Source - Delete source configuration
  • Status indicators: βœ“ (enabled) or β—‹ (disabled)

βš™οΈ Settings Management

  • Export Settings - Save complete configuration (sources, profiles, settings)
    • JSON format: Pretty-printed, easy to read
    • YAML format: Human-friendly, version control compatible
  • Import Settings - Restore or share configuration
    • Merge strategy: Add new sources/profiles, keep existing
    • Replace strategy: Clear all, restore from file
    • Format auto-detection from file extension

Settings Export/Import

Export your entire Prompt Registry configuration for backup, sharing, or migration:

# Export
1. Click Export button in Registry Explorer toolbar
2. Choose format: JSON or YAML
3. Select save location
4. Optionally open file after export

# Import
1. Click Import button in Registry Explorer toolbar
2. Select settings file (.json, .yaml, .yml)
3. Choose strategy:
   - Merge: Add new items, keep existing
   - Replace: Clear all, restore from file
4. Confirm operation

What's Included in Export:

  • All sources with URLs, types, priorities, and credentials
  • All profiles with their bundle associations
  • Extension settings (auto-updates, logging, etc.)
  • Timestamp and version information

Use Cases:

  • πŸ”„ Backup - Save configuration before major changes
  • πŸ‘₯ Team Sharing - Distribute standard source configurations
  • οΏ½οΏ½ Multi-Machine - Sync settings across workstations
  • πŸ”§ Version Control - Track configuration changes in Git

Learn more in the Settings Export/Import Guide.

πŸ”Œ Supported Sources

Awesome Copilot Collection

Pre-configured curated source for community prompts.

Type: awesome-copilot
URL: https://github.com/microsoft/prompt-bundle-spec
Collections Path: examples

Features:

  • βœ… Community-curated collections
  • βœ… Well-tested prompts
  • βœ… Regular updates
  • βœ… Wide variety of use cases

Local Awesome Copilot Collection

Local filesystem-based awesome-copilot collections for development and testing.

Type: local-awesome-copilot
URL: /path/to/collections  # or file:///path/to/collections
Collections Path: collections (default)

Features:

  • βœ… Develop collections locally before publishing
  • βœ… Test collection structure and content
  • βœ… No network dependencies
  • βœ… Fast iteration during development
  • βœ… Same format as awesome-copilot adapter

Directory Structure:

/path/to/collections/
β”œβ”€β”€ collections/
β”‚   β”œβ”€β”€ azure-cloud.collection.yml
β”‚   └── python-dev.collection.yml
β”œβ”€β”€ prompts/
β”‚   β”œβ”€β”€ azure-resource-health.prompt.md
β”‚   └── python-testing.prompt.md
└── instructions/
    └── bicep-best-practices.instructions.md

Collection File Format (.collection.yml):

id: my-collection
name: My Collection
description: Description of your collection
tags: [tag1, tag2, tag3]
items:
  - path: prompts/example.prompt.md
    kind: prompt
  - path: instructions/guidelines.instructions.md
    kind: instruction
  - path: chatmodes/mode.chatmode.md
    kind: chat-mode

Add Local Collection Source:

  1. Open Command Palette (Ctrl+Shift+P)
  2. Run Prompt Registry: Add Source
  3. Select type: local-awesome-copilot
  4. Enter path: /path/to/your/collections
  5. Bundles appear in Registry Explorer

Use Cases:

  • πŸ”§ Development - Build and test collections locally
  • πŸ§ͺ Testing - Validate structure before GitHub push
  • πŸš€ Prototyping - Quick experimentation with prompts
  • πŸ“ Documentation - Create examples for contributors

GitHub Repository

Any GitHub repository with collections.

Type: github
URL: https://github.com/owner/repo
Branch: main
Collections Path: prompts/collections

Requirements:

  • Repository must be public (or provide authentication)
  • Collections directory with .collection.yml files
  • Each collection references prompt files

GitLab Repository

GitLab repositories and releases.

Type: gitlab
URL: https://gitlab.com/owner/repo
Branch: main

HTTP/HTTPS Source

Any web-accessible ZIP bundles.

Type: http
URL: https://example.com/bundles/

Bundles must:

  • Be ZIP files
  • Contain deployment-manifest.yml
  • Be accessible via HTTPS (recommended)

Local Directory

File system directories.

Type: local
Path: /path/to/prompts

Useful for:

  • Private prompt libraries
  • Offline development
  • Testing custom bundles

πŸ—οΈ Architecture

High-Level Overview

graph TB
    subgraph "User Interface"
        MV[Marketplace View]
        TV[Tree View]
    end
    
    subgraph "Core Services"
        RM[Registry Manager]
        BI[Bundle Installer]
        CS[Copilot Sync]
    end
    
    subgraph "Adapters"
        ACA[Awesome Copilot]
        GHA[GitHub]
        GLA[GitLab]
        HTA[HTTP]
        LCA[Local]
    end
    
    MV --> RM
    TV --> RM
    RM --> BI
    BI --> CS
    RM --> ACA
    RM --> GHA
    RM --> GLA
    RM --> HTA
    RM --> LCA
    
    style RM fill:#4CAF50
    style BI fill:#2196F3
    style CS fill:#FF9800
Loading

For detailed architecture, see ARCHITECTURE.md

Key Components

  • Registry Manager: Orchestrates sources, bundles, and installations
  • Bundle Installer: Handles extraction, validation, and installation
  • Copilot Sync: Syncs bundles to GitHub Copilot directories
  • Adapters: Source-specific implementations (GitHub, GitLab, etc.)
  • UI Providers: Marketplace and tree view interfaces

Installation Flow

sequenceDiagram
    participant User
    participant Marketplace
    participant Adapter
    participant Installer
    participant Copilot
    
    User->>Marketplace: Click Install
    Marketplace->>Adapter: Download bundle
    Adapter-->>Installer: ZIP archive
    Installer->>Installer: Extract & validate
    Installer->>Copilot: Sync prompts
    Copilot-->>User: Ready to use
Loading

βš™οΈ Configuration

Extension Settings

Access via File β†’ Preferences β†’ Settings β†’ Extensions β†’ Prompt Registry

Setting Description Default
promptRegistry.autoSync Auto-sync to Copilot on install true
promptRegistry.cacheTimeout Bundle cache TTL (minutes) 5
promptRegistry.defaultScope Default installation scope user
promptRegistry.showNotifications Show success notifications true

Source Configuration

Sources are stored in ~/.vscode/extensions/.../registry.json:

{
  "sources": [
    {
      "id": "awesome-copilot",
      "name": "Awesome Copilot Collection",
      "type": "awesome-copilot",
      "url": "https://github.com/microsoft/prompt-bundle-spec",
      "enabled": true
    }
  ]
}

Bundle Manifest

Bundles must include deployment-manifest.yml:

version: "1.0"
id: "testing-automation"
name: "Testing & Test Automation"
version: "1.0.0"
description: "Comprehensive prompts for testing"
author: "github"
tags:
  - testing
  - automation
  - qa

prompts:
  - id: "unit-tests"
    name: "Unit Test Generator"
    type: "prompt"
    file: "prompts/unit-tests.prompt.md"
    tags:
      - unit-testing
      - tdd

πŸ”§ Troubleshooting

Common Issues

Bundles Not Showing in Copilot

Problem: Installed bundles don't appear in GitHub Copilot.

Solution:

  1. Check sync completed: View extension logs
  2. Verify directory: Check OS-specific path exists
  3. Restart VS Code: Reload window (Ctrl+R)
  4. Manual sync: Run "Prompt Registry: Sync All Bundles"

Installation Fails

Problem: "Failed to install bundle" error.

Solutions:

  • Network Error: Check internet connection
  • Permission Error: Ensure write access to user directory
  • Invalid Bundle: Verify bundle has valid manifest
  • Disk Space: Check available storage

Source Connection Failed

Problem: Cannot fetch bundles from source.

Solutions:

  • GitHub: Check repository URL and visibility
  • Authentication: Add access token if needed
  • Network: Verify HTTPS access not blocked
  • Rate Limiting: Wait before retrying

Wrong Installation Path (macOS)

Problem: Prompts install to ~/.config/Code instead of ~/Library/Application Support/Code.

Solution: Update to latest version (2.0.0+) with proper macOS support.

Debug Mode

Enable debug logging:

{
  "promptRegistry.debug": true
}

View logs in Output panel: View β†’ Output β†’ Prompt Registry

Getting Help


🀝 Contributing

We welcome contributions! See CONTRIBUTING.md for guidelines.

Development Setup

# Clone repository
git clone https://github.com/AmadeusITGroup/prompt-registry.git
cd prompt-registry

# Install dependencies
npm install

# Compile
npm run compile

# Watch mode (auto-compile)
npm run watch

# Run tests
npm test

# Package extension
vsce package

Creating a New Adapter

See ARCHITECTURE.md#extension-points for details on implementing custom adapters.

Project Structure

prompt-registry/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ adapters/          # Source adapters
β”‚   β”œβ”€β”€ commands/          # Command implementations
β”‚   β”œβ”€β”€ services/          # Core services
β”‚   β”œβ”€β”€ ui/               # UI providers
β”‚   β”œβ”€β”€ types/            # TypeScript types
β”‚   └── utils/            # Utilities
β”œβ”€β”€ docs/                  # Documentation
β”œβ”€β”€ test/                  # Test suites
└── package.json          # Extension manifest

πŸ“š Documentation


πŸ—ΊοΈ Roadmap

Current Version (2.0.0)

  • βœ… Visual marketplace interface
  • βœ… Multi-source support (6 adapter types)
  • βœ… Profile management
  • βœ… Cross-platform support (macOS, Linux, Windows)
  • βœ… Auto-sync with GitHub Copilot
  • βœ… Search and filtering
  • βœ… Clickable marketplace tiles

Upcoming (2.1.0)

  • πŸ”„ Automatic bundle updates
  • πŸ”„ Bundle versioning and rollback
  • πŸ”„ Dependency management
  • πŸ”„ Bundle analytics

Future (3.0.0)

  • πŸ“‹ Bundle authoring tools
  • πŸ“‹ Community ratings and reviews
  • πŸ“‹ AI-powered recommendations
  • πŸ“‹ Collaborative prompt sharing
  • πŸ“‹ Marketplace API for third-party tools

πŸ“„ License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.


πŸ™ Acknowledgments

  • Microsoft - For GitHub Copilot and VS Code
  • Awesome Copilot Community - For curated prompt collections
  • Contributors - Everyone who has contributed to this project

πŸ“Š Stats

  • Supported Source Types: 6 (GitHub, GitLab, HTTP, Local, Awesome Copilot, Local Awesome Copilot)
  • Platforms: macOS, Linux, Windows
  • VS Code Flavors: Stable, Insiders, Windsurf
  • Architecture: Adapter pattern with extensible design
  • Bundle Format: YAML-based deployment manifest

πŸ”— Links


Made with ❀️ by the Prompt Registry Team

Report Bug Β· Request Feature Β· Documentation