Skip to content

getting-started.md

Latest commit

 

History

History
59 lines (40 loc) · 2.76 KB

getting-started.md

File metadata and controls

59 lines (40 loc) · 2.76 KB

Getting Started

Prerequisites

  • VS Code 1.99.3+
  • GitHub Copilot (for using prompts)

Installation

Search "Prompt Registry" in VS Code Extensions (Ctrl+Shift+X) and click Install.

Alternatively, install directly from the VS Code Marketplace. You will be prompted to authenticate with GitHub — click Allow and sign in.

First Launch: GitHub Account and Hub Selection

On first launch, Prompt Registry shows a welcome dialog to help you get started:

  1. GitHub Account — If you have multiple GitHub accounts signed in to VS Code, Prompt Registry asks which one to use. Pick the account that has access to the hub or sources you need. If only one account is signed in, you can still add another from the same picker. Cancelling this step leaves the extension in a "Setup Not Complete" state; on the next launch you will see a "Would you like to resume?" prompt. You can also re-pick later by running the Prompt Registry: Force GitHub Authentication command (promptregistry.forceGitHubAuth) from the Command Palette.

  2. Hub Selector — Choose from available hubs:

    • Pre-configured hubs (verified for availability)
    • Custom Hub URL (enter your own)
    • Skip for now (configure later)

  3. Automatic Setup — When you select a hub:

    • The hub is imported and set as active
    • Sources defined in the hub are synced
    • The first profile is auto-activated (if available)
    • Awesome Copilot source is added automatically

  4. Ongoing Sync — On each VS Code startup, the active hub is automatically synced to keep your configuration up-to-date.

To reset and re-trigger the first-run experience: Ctrl+Shift+P → "Prompt Registry: Reset First Run"

Quick Start (5 minutes)

  1. Pick GitHub Account, then Select Hub — Choose which GitHub account to use, then pick a hub from the welcome dialog (or skip)
  2. Open Marketplace — Click the Prompt Registry icon in the Activity Bar
  3. Browse — Search or filter by tags/source
  4. Install — Click a bundle tile → Install
  5. Use — Prompts appear in Copilot Chat as /<bundle-id>-<prompt-id>

Installed files location:

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

Add Your Own Source

  1. Registry Explorer → Add Source
  2. Choose type: github, local, awesome-copilot, local-awesome-copilot, apm, or local-apm
  3. Enter URL/path

See Also