Troubleshooting Guide
Diagnose and fix common issues with Boring.
🔍 Diagnosis Tools
Before trying manual fixes, use built-in diagnosis tools:
# Check environment, system health, and perform deep optimization
boring doctor --fix
boring doctor --optimize
# Show current configuration (useful for debugging)
boring config show
# View logs
tail -f ~/.boring_logs/boring.log
🛑 Common Issues
1. "Agent is stuck in Thinking state"
Symptoms: The spinner keeps spinning for > 2 minutes with no output.
Causes: - API rate limits (429) - Complex prompt causing timeout - Network connectivity issues
Solutions:
1. Check logs: tail ~/.boring_logs/boring.log for API errors.
2. Restart: Ctrl+C to stop, then boring start again. Boring resumes from memory.
3. Reset context: If stuck on a bad thought loop:
2. "RAG search returns no results"
Symptoms: boring_rag_search returns empty list.
Causes:
- Index not built
- Embeddings missing
- .gitignore excluding source files
Solutions: 1. Force re-index:
2. Check.gitignore: Ensure src/ is not ignored.
3. Verify installation: Run pip show chromadb. If missing, install boring-aicoding[mcp].
3. "Shadow Mode blocking everything"
Symptoms: Every operation asks for approval, even safe ones.
Causes:
- Level set to STRICT in global config.
- auto_approve_patterns are empty.
Solutions: 1. Check level:
2. Lower level (if safe): 3. Reset config: Delete~/.boring/brain/shadow_config.json to restore defaults.
4. "Smithery installation fails on Gemini Client"
Symptoms: Error during npx installation or "Connection refused".
Causes: - Gemini Client has specific network/environment constraints for Smithery.
Solution:
Use local pip installation as fallback:
1. git clone https://github.com/Boring206/boring-gemini.git
2. pip install -e .
3. Configure MCP manually (see Configuration).
5. "Verification fails on clean code"
Symptoms: boring verify reports errors that exist only in cache.
Causes: - Stale cache file.
Solution: 1. Clear cache:
2. Run fresh verification:🐛 Debugging Modes
Enable Debug Logs
In .boring.toml:
Or via ENV:
Trace API Calls
To see exactly what's sent to the LLM:
🆘 Getting Help
If these steps don't fix it:
- Run
boring doctorand save the output. - Collect logs: Zip
~/.boring_logs/. - Open an Issue: GitHub Issues with the above info.
6. "Tools are missing / Command not found"
Symptoms: You try to use boring_code_review or boring_test_gen but the agent says "Tool not found".
Causes:
- You are likely in minimal or ultra_lite profile.
Solution: 1. Check current profile:
2. Switch tolite or standard:
See MCP Profiles Guide for details.
7. "System verification is too slow"
Symptoms: boring doctor or boring verify takes a long time scanning project history.
Causes:
- Massive events.jsonl file.
- Redundant brain index scanning.
Solution: 1. Enable System Optimization:
This will: * Rotate the Ledger: Splitevents.jsonl into archived segments.
* Create Checkpoints: Enable incremental scanning for nearly-instant verification.
* Compress State: Use Gzip to shrink project snapshots.
2. Perform Maintenance: Ensure your code is frequently committed to keep the incremental reconciler efficient.