README.md

April 15, 2026 · View on GitHub

lynxprompt-vscode banner

LynxPrompt for VS Code banner

LynxPrompt

LynxPrompt for VS Code

Browse, pull, diff, and push AI config files directly from the editor

CI Coverage Marketplace version Marketplace installs GitHub Release GitHub Stars License

Install from Marketplace · Open in VS Code · LynxPrompt Platform · Main Repository


What is this?

The official VS Code extension for LynxPrompt — a self-hostable platform for managing AI IDE configuration files (AGENTS.md, CLAUDE.md, .cursor/rules/, copilot-instructions.md, .windsurfrules, and 30+ more formats).

This extension brings LynxPrompt directly into your editor so you can manage cloud blueprints and local config files without switching to the browser.


Install

Install from the VS Code Marketplace or run:

ext install LynxPrompt.lynxprompt

Features

Browse Blueprints and Local Files

Use the dedicated sidebar to see your LynxPrompt blueprints and the AI config files detected in the current workspace.

  • My Blueprints shows cloud blueprints grouped by type
  • Local Config Files shows workspace files with sync status indicators

Sign In with Device Flow

Authenticate securely without copying tokens by hand.

  1. Run LynxPrompt: Sign In
  2. Complete authentication in your browser
  3. Return to VS Code and start browsing your blueprints

Pull Blueprints into the Right Paths

Download a blueprint and let the extension place it in the correct workspace location automatically.

  • CLAUDE.md
  • AGENTS.md
  • .cursor/rules/
  • .github/copilot-instructions.md
  • .windsurfrules

Push Local Configs Back to LynxPrompt

Right-click a supported file or use the command palette to upload local configs as blueprints.

Diff Local vs Cloud

Open the built-in VS Code diff editor to compare a local file with its linked cloud blueprint before deciding what to keep.

Generate and Convert

Open the LynxPrompt wizard in your browser to generate new configs, or convert supported config formats locally.

Watch for Drift

The extension monitors linked config files and notifies you when local files diverge from the cloud version.

Commands

CommandDescription
LynxPrompt: Sign InAuthenticate with LynxPrompt using device flow
LynxPrompt: Sign OutClear stored credentials
LynxPrompt: Refresh BlueprintsReload blueprint list from the cloud
LynxPrompt: Refresh Local FilesRescan the workspace for AI config files
LynxPrompt: Pull Blueprint to WorkspaceDownload a blueprint to the correct file path
LynxPrompt: Push to LynxPromptUpload a local config file as a blueprint
LynxPrompt: Compare with CloudOpen the diff editor for local vs cloud
LynxPrompt: Generate ConfigOpen the LynxPrompt wizard in your browser
LynxPrompt: Convert FormatConvert between supported AI config formats

Extension Settings

SettingDefaultDescription
lynxprompt.apiUrlhttps://lynxprompt.comBase URL for the LynxPrompt API.
lynxprompt.autoDetectConfigFilestrueAutomatically detect AI configuration files in the workspace.
lynxprompt.watchFileChangestrueWatch linked files and notify on divergence from cloud.
lynxprompt.showStatusBartrueShow connection status in the status bar.

Self-Hosting

If you run your own LynxPrompt instance, change the API URL in settings:

{
  "lynxprompt.apiUrl": "https://lynxprompt.yourdomain.com"
}

Requirements

Development

npm install
npm run watch   # dev mode with auto-rebuild
npm run build   # production build
npm run package # create .vsix

Press F5 in VS Code to launch the Extension Development Host.

Contributing

Contributions are welcome. Open an issue first to discuss substantial changes.

ProjectDescription
LynxPromptSelf-hosted platform for AI IDE/Tools Rules and Commands via WebUI and CLI
lynxprompt-actionGitHub Action to sync and validate AI IDE configuration files with LynxPrompt
lynxprompt-mcpMCP Server for LynxPrompt AI configuration blueprint management
n8n-nodes-lynxpromptn8n community node for LynxPrompt AI configuration blueprints
homebrew-lynxpromptHomebrew tap for LynxPrompt CLI

License

GPL-3.0