Context Compiler
A VS Code extension that analyzes your project, scaffolds your tech stack, and generates a structured context file ready to paste into any AI chat.
Features
- Setup Wizard — Configure your tech stack interactively with auto-detection from
package.json.
- Scaffold Project — Detects missing dependencies and installs them via an integrated terminal.
- Compile Context — Generates a
CONTEXT.md with your stack, all dependencies, and project structure.
Commands
| Command |
Description |
Context Compiler: Open Setup Wizard |
Run the interactive project setup wizard |
Context Compiler: Detect Technologies |
Auto-detect tech stack from package.json |
Context Compiler: Edit Configuration |
Open .context-compiler.json directly |
Context Compiler: Scaffold Project |
Install missing dependencies from your stack |
Context Compiler: Compile Context |
Generate a context file for AI tools |
Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
Requirements
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
Extension Settings
Include if your extension adds any VS Code settings through the contributes.configuration extension point.
For example:
This extension contributes the following settings:
myExtension.enable: Enable/disable this extension.myExtension.thing: Set to blah to do something.
Known Issues
Calling out known issues can help limit users opening duplicate issues against your extension.
Release Notes
Users appreciate release notes as you update your extension.
1.0.0
Initial release of ...
1.0.1
Fixed issue #.
1.1.0
Added features X, Y, and Z.
Following extension guidelines
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
Working with Markdown
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
- Split the editor (
Cmd+\ on macOS or Ctrl+\ on Windows and Linux).
- Toggle preview (
Shift+Cmd+V on macOS or Shift+Ctrl+V on Windows and Linux).
- Press
Ctrl+Space (Windows, Linux, macOS) to see a list of Markdown snippets.
Enjoy!
