Common Issues
Splat command not found
Splat command not found
This usually means Splat is not installed or not in your PATH.Solution:
-
Verify installation:
-
If not installed, install Splat:
-
Ensure your Python scripts directory is in PATH:
Code formatting issues after fixes
Code formatting issues after fixes
Splat currently does not conform to formatting configurations when inserting code.Solution:After Splat fixes your code, run your formatter manually:Or if using other formatters:
Sub-module entrypoint errors
Sub-module entrypoint errors
Splat may not work correctly with entrypoints that don’t originate in the root directory.Solution:
-
Run Splat from your project root directory:
-
Or create a wrapper script in the root that calls your sub-module:
Then use:
Missing API key or Groq errors
Missing API key or Groq errors
Splat uses Groq for AI inference and requires an API key.Solution:
-
Check if you have a
.envfile with your Groq API key: -
If missing, create a
.envfile: - Get your API key from Groq Console
Git-aware features not working
Git-aware features not working
If Splat is not respecting your
.gitignore file:Solution:-
Ensure you’re in a Git repository:
-
Verify your
.gitignorefile exists: -
Re-initialize Git if necessary:
Installation dependency errors
Installation dependency errors
Missing dependencies can cause various errors.Solution:Install all required dependencies:Or install individually:
Command not executing properly
Command not executing properly
If your command runs but Splat doesn’t capture errors:Solution:
-
Ensure you’re wrapping the command in quotes:
-
Try the
-rflag for more context: - Check that the command fails when run normally (Splat needs errors to debug)
Debug Mode
For more detailed error information, you can:-
Check Python traceback:
-
Run with Python debugger:
- Enable verbose output in your terminal
Getting Help
If you’re still experiencing issues:- Check the Known Issues page
- Review the Contributing Guide to report bugs
- Search existing issues on the project repository
- Create a detailed bug report with:
- Your operating system and Python version
- Complete error messages
- Steps to reproduce the issue
- Expected vs actual behavior