Skip to content

Latest commit

 

History

History
140 lines (102 loc) · 6.62 KB

FAQ.md

File metadata and controls

140 lines (102 loc) · 6.62 KB

Frequently Asked Questions (FAQ)

What are the best models for bolt.diy?

Available models and their capabilities change over time. Choose a capable coding model with a context window large enough for your project; use a faster, smaller model for quick edits or when cost and latency matter. For private or offline work, configure a local provider such as Ollama or LM Studio. Check the model catalog in Settings for the options currently available from your configured providers.

How do I get the best results with bolt.diy?
  • Be specific about your stack:
    Mention the frameworks or libraries you want to use (e.g., Astro, Tailwind, ShadCN) in your initial prompt. This ensures that bolt.diy scaffolds the project according to your preferences.

  • Use the enhance prompt icon:
    Before sending your prompt, click the enhance icon to let the AI refine your prompt. You can edit the suggested improvements before submitting.

  • Scaffold the basics first, then add features:
    Ensure the foundational structure of your application is in place before introducing advanced functionality. This helps bolt.diy establish a solid base to build on.

  • Batch simple instructions:
    Combine simple tasks into a single prompt to save time and reduce API credit consumption. For example:
    "Change the color scheme, add mobile responsiveness, and restart the dev server."

How do I contribute to bolt.diy?

Check out our Contribution Guide for more details on how to get involved!

What are the future plans for bolt.diy?

Visit our Roadmap for the latest updates.
New features and improvements are on the way!

Why are there so many open issues/pull requests?

bolt.diy began as a small showcase project on @ColeMedin's YouTube channel to explore editing open-source projects with local LLMs. However, it quickly grew into a massive community effort!

We're forming a team of maintainers to manage demand and streamline issue resolution. The maintainers are rockstars, and we're also exploring partnerships to help the project thrive.

How do local LLMs compare to hosted models for bolt.diy?

Local models can provide privacy and offline access, while larger hosted models often handle complex projects more reliably. Performance depends on the model, available context, and your hardware. Try a small task first, then choose the model that best fits your quality, privacy, cost, and speed needs.

Common Errors and Troubleshooting

"There was an error processing this request"

This generic error message means something went wrong. Check these locations:

  • Terminal output (if using Docker or pnpm)
  • Browser developer console (press F12 -> Console tab)
  • Server logs for backend errors
  • Network tab to verify API calls are succeeding

"x-api-key header missing"

This authentication error can be resolved by:

  • Restarting the container: docker compose restart
  • Switching run methods: Try pnpm if using Docker, or vice versa
  • Checking API keys in .env.local or Settings -> Providers
  • Clearing browser cache

Blank preview when running the app

Blank previews usually indicate code generation issues:

  • Check developer console for JavaScript runtime errors
  • Verify WebContainer is running properly
  • Try refreshing the preview pane
  • Check for hallucinated or incomplete code in generated files
  • Restart the development server if issues persist

How do I use MCP tools?

Configure a server under Settings → Integrations → MCP Servers. In the prompt composer, open the attachment menu and choose MCP Tools Available to select tools for your prompt.

MCP server connection failed

If you're having trouble with MCP integrations:

  • Verify server configuration in Settings → Integrations → MCP Servers
  • Check server endpoints and authentication credentials
  • Test server connectivity outside of bolt.diy
  • Review MCP server logs for specific errors
  • Ensure server supports the MCP protocol version

Git integration not working

Common Git-related issues and solutions:

  • GitHub connection failed: Verify your GitHub token has correct permissions
  • Repository not found: Check repository URL and access permissions
  • Push/pull failed: Ensure you have write access to the repository
  • Merge conflicts: Resolve conflicts manually or use the diff viewer
  • Large files blocked: Check GitHub's file size limits

Deployment failed

Deployment issues can be resolved by:

  • Checking build logs for specific error messages
  • Verifying environment variables are set correctly
  • Testing locally before deploying (pnpm run build && pnpm run preview)
  • Checking platform-specific requirements (Node version, build commands)
  • Reviewing deployment configuration in platform settings

Provider not showing up after adding it

If your custom LLM provider isn't appearing:

  • Restart the development server to reload providers
  • Check the provider registry in app/lib/modules/llm/registry.ts
  • Verify the provider class extends BaseProvider correctly and returns LanguageModel from 'ai'
  • Check browser console for provider loading errors
  • Ensure proper TypeScript compilation (pnpm run typecheck)

WebContainer preview not loading

If the live preview isn't working:

  • Check WebContainer status in the terminal
  • Verify Node.js compatibility with your project
  • Restart the development environment
  • Clear browser cache and reload
  • Check for conflicting ports (default is 5173)

"Everything works, but the results are bad"

Local LLMs can work well for smaller applications, while larger hosted models may handle complex projects more reliably. Try a small task first and choose based on the quality, privacy, cost, and speed you need.

"Received structured exception #0xc0000005: access violation"

Windows-specific issue: Update the Visual C++ Redistributable.

"Miniflare or Wrangler errors in Windows"

Windows development environment: Install Visual Studio C++ (version 14.40.33816 or later). More details in GitHub Issues.


Got more questions? Feel free to reach out or open an issue in our GitHub repo!