{"id":32791528,"url":"https://github.com/manasdutta04/layr","last_synced_at":"2025-11-05T13:01:48.172Z","repository":{"id":322052411,"uuid":"1074069888","full_name":"manasdutta04/layr","owner":"manasdutta04","description":"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.","archived":false,"fork":false,"pushed_at":"2025-11-02T09:03:38.000Z","size":97,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-11-02T11:12:25.384Z","etag":null,"topics":["ai","hacktoberfest","hacktoberfest-25","planner","vscode-extension"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=ManasDutta.layr","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/manasdutta04.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"manasdutta04","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":null,"thanks_dev":null,"custom":null}},"created_at":"2025-10-11T05:05:50.000Z","updated_at":"2025-11-02T09:36:17.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/manasdutta04/layr","commit_stats":null,"previous_names":["manasdutta04/layr"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/manasdutta04/layr","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manasdutta04%2Flayr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manasdutta04%2Flayr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manasdutta04%2Flayr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manasdutta04%2Flayr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/manasdutta04","download_url":"https://codeload.github.com/manasdutta04/layr/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manasdutta04%2Flayr/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":282823603,"owners_count":26733133,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-11-05T02:00:05.946Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","hacktoberfest","hacktoberfest-25","planner","vscode-extension"],"created_at":"2025-11-05T13:01:08.821Z","updated_at":"2025-11-05T13:01:48.164Z","avatar_url":"https://github.com/manasdutta04.png","language":"TypeScript","funding_links":["https://github.com/sponsors/manasdutta04"],"categories":[],"sub_categories":[],"readme":"# Layr - AI Planning Layer\n\n**Transform your ideas into structured project plans with AI-powered planning for VS Code.**\n\nLayr 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.\n\n## Demo Video\n\n[Watch the demo video](https://youtu.be/9xtDDoh-Fg8)\n\n\n## Key Benefits\n\n**Intelligent Planning** : Leverages Google's Gemini AI to create detailed, context-aware project plans tailored to your specific requirements.\n\n**Zero Setup Required** : Works immediately with built-in templates. No API key needed for basic functionality.\n\n**Seamless Integration** : Native VS Code integration through Command Palette with instant access to planning tools.\n\n**Flexible Output** : Generates editable Markdown documents that you can customize and reference throughout development.\n\n**Smart Fallback** : Automatically switches to offline template mode if AI service is unavailable.\n\n**Secure Configuration** : Multiple options for API key storage with built-in security best practices.\n\n## Installation\n\n### From VS Code Marketplace\n1. Open VS Code\n2. Go to Extensions (Ctrl+Shift+X)\n3. Search for \"Layr\"\n4. Click Install\n\n### From Source\n1. Clone this repository\n2. Open in VS Code\n3. Run `npm install`\n4. Press F5 to launch in Extension Development Host\n\n## Configuration\n\n### AI-Powered Plans \n\nLayr now supports multiple AI providers! Choose from Gemini, OpenAI, or Claude to generate your project plans.\n\n**Step 1: Choose Your AI Provider**\n1. Open VS Code Settings (Ctrl+,)\n2. Search for \"layr\"\n3. Set \"AI Provider\" to your preferred option:\n   - `gemini` (default) - Google's Gemini AI\n   - `openai` - OpenAI's GPT models\n   - `claude` - Anthropic's Claude models\n\n**Step 2: Configure API Key**\n\n**For Gemini:**\n1. Get your API key from [Google AI Studio](https://makersuite.google.com/app/apikey)\n2. Enter your API key in the \"Gemini Api Key\" field\n\n**For OpenAI:**\n1. Get your API key from [OpenAI Platform](https://platform.openai.com/api-keys)\n2. Enter your API key in the \"OpenAI Api Key\" field\n3. Optionally set your organization ID in \"OpenAI Organization\"\n\n**For Claude:**\n1. Get your API key from [Anthropic Console](https://console.anthropic.com/)\n2. Enter your API key in the \"Claude Api Key\" field\n\n**Step 3: Choose Model (Optional)**\n- Gemini Model: `gemini-pro` (default) or `gemini-pro-vision`\n- OpenAI Model: `gpt-4` (default), `gpt-4-turbo`, or `gpt-3.5-turbo`\n- Claude Model: `claude-3-sonnet` (default), `claude-3-opus`, or `claude-3-haiku`\n\n**Alternative: Environment Variables**\nAdd to your `.env` file or system environment:\n```bash\n# Choose one or more based on your preferred provider\nGEMINI_API_KEY=your_gemini_api_key_here\nOPENAI_API_KEY=your_openai_api_key_here\nCLAUDE_API_KEY=your_claude_api_key_here\n```\n\n**Security Note** : API keys are stored locally and never transmitted except to the respective AI provider's API. The extension is configured to prevent accidental commits of sensitive information.\n\n## Usage Guide\n\n### Creating a Plan\n\n1. **Open Command Palette** : Press `Ctrl+Shift+P` (Windows/Linux) or `Cmd+Shift+P` (Mac)\n2. **Run Command** : Type \"Layr: Create Plan\" and press Enter\n3. **Describe Your Project** : Enter a natural language description of what you want to build\n   - Example: \"A React todo app with user authentication and real-time updates\"\n   - Example: \"A REST API for a blog platform with user management\"\n   - Example: \"A Python data analysis script for sales reporting\"\n4. **Review Generated Plan** : The extension will create a new Markdown file with your project plan\n5. **Customize as Needed** : Edit the generated plan to match your specific requirements\n\n### Best Practices for Prompts\n\n**Be Specific** : Include technology preferences, key features, and constraints\n- Good: \"A Node.js REST API with JWT authentication, PostgreSQL database, and Docker deployment\"\n- Basic: \"A web API\"\n\n**Mention Context** : Include information about scale, audience, or special requirements\n- \"A mobile-first React app for small businesses with offline capability\"\n- \"A Python script for processing large CSV files with memory optimization\"\n\n**Include Constraints** : Mention any limitations or preferences\n- \"Using only free/open-source technologies\"\n- \"Must be deployable on AWS Lambda\"\n\n## Available Commands\n\n| Command | Description | Shortcut |\n|---------|-------------|----------|\n| `Layr: Create Plan` | Generate a new project plan from description | None |\n| `Layr: Execute Plan` | Execute current plan (coming soon) | None |\n\n## Plan Output Structure\n\nGenerated plans include:\n\n**Project Overview** : High-level description and objectives\n**Requirements** : Functional and technical requirements\n**Architecture** : System design and component structure\n**Technology Stack** : Recommended tools and frameworks\n**Implementation Steps** : Detailed development phases\n**File Structure** : Suggested project organization\n**Testing Strategy** : Approach for quality assurance\n**Deployment**  : Production deployment considerations\n\n## AI vs Template Mode\n\n### AI Mode (Gemini)\n**Advantages** :\n- Highly customized plans based on your specific description\n- Considers modern best practices and current technologies\n- Adapts to complex or unique project requirements\n- Provides detailed explanations and rationale\n\n**Requirements** :\n- Internet connection\n- Valid Gemini API key\n- Google AI Studio account\n\n**Best For** : Complex projects, modern tech stacks, unique requirements\n\n### Template Mode (Offline - currently on testing)\n**Advantages** :\n- Works without internet connection\n- No API key required\n- Instant generation\n- Consistent structure\n\n**Limitations** :\n- Limited to predefined project types\n- Less customization\n- May not reflect latest technologies\n\n**Best For** : Common project patterns, quick prototyping, offline development\n\n## Troubleshooting\n\n### Common Issues\n\n**\"Failed to generate plan\"**\n- Check internet connection\n- Verify API key is correctly configured\n- Try using template mode as fallback\n\n**\"API key not found\"**\n- Ensure API key is set in VS Code settings\n- Check that the key is valid and active\n- Verify the key has appropriate permissions\n\n**\"Extension not responding\"**\n- Reload VS Code window (Ctrl+Shift+P → \"Developer: Reload Window\")\n- Check VS Code output panel for error messages\n- Ensure extension is properly installed and enabled\n\n### Getting Help\n\n- Check the [GitHub repository](https://github.com/manasdutta04/layr) for known issues\n- Review VS Code's extension troubleshooting guide\n- Submit bug reports with detailed error messages and steps to reproduce\n\n## Privacy and Security\n\n- API keys are stored locally in VS Code settings\n- No data is collected or transmitted except to Google's Gemini API\n- Generated plans remain on your local machine\n- All communication with external services uses secure HTTPS connections\n\n## Contributing\n\nContributions are welcome! Please see the repository for development setup instructions and contribution guidelines.\n\n## License\n\nThis project is licensed under the MIT License. See the LICENSE file for details.\n\n\n##  Development\n\n### Prerequisites\n- Node.js 16+\n- VS Code\n- TypeScript knowledge\n\n### Setup\n```bash\n# Install dependencies\nnpm install\n\n# Compile TypeScript\nnpm run compile\n\n# Watch for changes\nnpm run watch\n\n# Debug in VS Code\n# Press F5 to launch Extension Development Host\n```\n\n### Building\n```bash\n# Compile for production\nnpm run vscode:prepublish\n```\n\n##  Configuration Options\n\n| Setting | Type | Default | Description |\n|---------|------|---------|-------------|\n| `layr.geminiApiKey` | string | `\"\"` | Your Gemini AI API key for generating intelligent plans |\n\n##  Contributing\n\n1. Fork the repository\n2. Create a feature branch\n3. Make your changes\n4. Add tests if applicable\n5. Submit a pull request\n\n##  License\n\nMIT License - see LICENSE file for details\n\n##  Acknowledgments\n\n- Developed by [Manas Dutta](https://github.com/manasdutta04)\n- Built with [VS Code Extension API](https://code.visualstudio.com/api)\n\n## Issues \u0026 Support\n\nIf you encounter any issues or have suggestions:\n1. Check existing issues on GitHub\n2. Create a new issue with detailed description\n3. Include VS Code version and extension logs\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanasdutta04%2Flayr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmanasdutta04%2Flayr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanasdutta04%2Flayr/lists"}