Skip to main content

Common Issues

This usually means Splat is not installed or not in your PATH.Solution:
  1. Verify installation:
    pip show splat
    
  2. If not installed, install Splat:
    pip install -e .
    
  3. Ensure your Python scripts directory is in PATH:
    export PATH="$HOME/.local/bin:$PATH"
    
Splat currently does not conform to formatting configurations when inserting code.Solution:After Splat fixes your code, run your formatter manually:
black your_file.py
Or if using other formatters:
# Prettier for JavaScript/TypeScript
prettier --write your_file.js

# autopep8 for Python
autopep8 --in-place your_file.py
Splat may not work correctly with entrypoints that don’t originate in the root directory.Solution:
  1. Run Splat from your project root directory:
    cd /path/to/project/root
    splat squash "python3 submodule/main.py"
    
  2. Or create a wrapper script in the root that calls your sub-module:
    # run.py
    from submodule import main
    main.run()
    
    Then use:
    splat squash "python3 run.py"
    
Splat uses Groq for AI inference and requires an API key.Solution:
  1. Check if you have a .env file with your Groq API key:
    cat .env
    
  2. If missing, create a .env file:
    echo "GROQ_API_KEY=your_api_key_here" > .env
    
  3. Get your API key from Groq Console
If Splat is not respecting your .gitignore file:Solution:
  1. Ensure you’re in a Git repository:
    git status
    
  2. Verify your .gitignore file exists:
    ls -la .gitignore
    
  3. Re-initialize Git if necessary:
    git init
    
Missing dependencies can cause various errors.Solution:Install all required dependencies:
pip install -r requirements.txt
Or install individually:
pip install click repopack setuptools virtualenv groq fastapi uvicorn python-dotenv prompt_toolkit requests black pydantic_ai pydantic zmq
If your command runs but Splat doesn’t capture errors:Solution:
  1. Ensure you’re wrapping the command in quotes:
    splat squash "python3 main.py"
    
  2. Try the -r flag for more context:
    splat squash -r "python3 main.py"
    
  3. Check that the command fails when run normally (Splat needs errors to debug)

Debug Mode

For more detailed error information, you can:
  1. Check Python traceback:
    python3 -v your_script.py
    
  2. Run with Python debugger:
    python3 -m pdb your_script.py
    
  3. 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

Build docs developers (and LLMs) love