Layr - AI Planning Layer

Transform your ideas into structured project plans with AI-powered planning for VS Code.

Layr is a VS Code extension that generates comprehensive, actionable project plans from natural language descriptions. Whether you're starting a new project or planning a feature, Layr helps you think through the architecture, requirements, and implementation steps before you write the first line of code.

Demo Video

Watch the demo video

Key Benefits

Intelligent Planning : Leverages Google's Gemini AI to create detailed, context-aware project plans tailored to your specific requirements.

Zero Setup Required : Works immediately with built-in templates. No API key needed for basic functionality.

Seamless Integration : Native VS Code integration through Command Palette with instant access to planning tools.

Flexible Output : Generates editable Markdown documents that you can customize and reference throughout development.

Smart Fallback : Automatically switches to offline template mode if AI service is unavailable.

Secure Configuration : Multiple options for API key storage with built-in security best practices.

Installation

From VS Code Marketplace

1. Open VS Code
2. Go to Extensions (Ctrl+Shift+X)
3. Search for "Layr"
4. Click Install

From Source

1. Clone this repository
2. Open in VS Code
3. Run npm install
4. Press F5 to launch in Extension Development Host

Configuration

AI-Powered Plans (Optional)

To enable AI-generated plans, configure your Gemini API key using one of these methods:

Method 1: VS Code Settings UI (Recommended)

1. Get your API key from Google AI Studio
2. Open VS Code Settings (Ctrl+,)
3. Search for "layr"
4. Enter your API key in the "Gemini Api Key" field

Method 2: Settings File

1. Copy .vscode/settings.example.json to .vscode/settings.json
2. Replace YOUR_GEMINI_API_KEY_HERE with your actual API key
3. The settings.json file is automatically ignored by git

Method 3: Environment Variable Add to your .env file:

GEMINI_API_KEY=your_api_key_here

Security Note : API keys are stored locally and never transmitted except to Google's Gemini API. The extension is configured to prevent accidental commits of sensitive information.

Usage Guide

Creating a Plan

1. Open Command Palette : Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac)
2. Run Command : Type "Layr: Create Plan" and press Enter
3. Describe Your Project : Enter a natural language description of what you want to build
   • Example: "A React todo app with user authentication and real-time updates"
   • Example: "A REST API for a blog platform with user management"
   • Example: "A Python data analysis script for sales reporting"
4. Review Generated Plan : The extension will create a new Markdown file with your project plan
5. Customize as Needed : Edit the generated plan to match your specific requirements

Best Practices for Prompts

Be Specific : Include technology preferences, key features, and constraints

• Good: "A Node.js REST API with JWT authentication, PostgreSQL database, and Docker deployment"
• Basic: "A web API"

Mention Context : Include information about scale, audience, or special requirements

• "A mobile-first React app for small businesses with offline capability"
• "A Python script for processing large CSV files with memory optimization"

Include Constraints : Mention any limitations or preferences

• "Using only free/open-source technologies"
• "Must be deployable on AWS Lambda"

Available Commands

Plan Output Structure

Generated plans include:

Project Overview : High-level description and objectives Requirements : Functional and technical requirements Architecture : System design and component structure Technology Stack : Recommended tools and frameworks Implementation Steps : Detailed development phases File Structure : Suggested project organization Testing Strategy : Approach for quality assurance Deployment : Production deployment considerations

AI vs Template Mode

AI Mode (Gemini)

Advantages :

• Highly customized plans based on your specific description
• Considers modern best practices and current technologies
• Adapts to complex or unique project requirements
• Provides detailed explanations and rationale

Requirements :

• Internet connection
• Valid Gemini API key
• Google AI Studio account

Best For : Complex projects, modern tech stacks, unique requirements

Template Mode (Offline - currently on testing)

Advantages :

• Works without internet connection
• No API key required
• Instant generation
• Consistent structure

Limitations :

• Limited to predefined project types
• Less customization
• May not reflect latest technologies

Best For : Common project patterns, quick prototyping, offline development

Troubleshooting

Common Issues

"Failed to generate plan"

• Check internet connection
• Verify API key is correctly configured
• Try using template mode as fallback

"API key not found"

• Ensure API key is set in VS Code settings
• Check that the key is valid and active
• Verify the key has appropriate permissions

"Extension not responding"

• Reload VS Code window (Ctrl+Shift+P → "Developer: Reload Window")
• Check VS Code output panel for error messages
• Ensure extension is properly installed and enabled

Getting Help

• Check the GitHub repository for known issues
• Review VS Code's extension troubleshooting guide
• Submit bug reports with detailed error messages and steps to reproduce

Privacy and Security

• API keys are stored locally in VS Code settings
• No data is collected or transmitted except to Google's Gemini API
• Generated plans remain on your local machine
• All communication with external services uses secure HTTPS connections

Contributing

Contributions are welcome! Please see the repository for development setup instructions and contribution guidelines.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Development

Prerequisites

• Node.js 16+
• VS Code
• TypeScript knowledge

Setup

# Install dependencies
npm install

# Compile TypeScript
npm run compile

# Watch for changes
npm run watch

# Debug in VS Code
# Press F5 to launch Extension Development Host

Building

# Compile for production
npm run vscode:prepublish

Configuration Options

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

License

MIT License - see LICENSE file for details

Acknowledgments

• Developed by Manas Dutta
• Inspired by Traycer - the planning-first approach to development
• Powered by Google Gemini AI
• Built with VS Code Extension API

Issues & Support

If you encounter any issues or have suggestions:

1. Check existing issues on GitHub
2. Create a new issue with detailed description
3. Include VS Code version and extension logs