Skip to main content

​
Overview

Splat requires minimal configuration to get started. The primary requirement is setting up your Groq API credentials for AI-powered error analysis.

​
Installation

Before configuring Splat, ensure you have installed it: 
pip install splat
Or install from source: 
git clone https://github.com/ehcaw/splat
cd splat
pip install -e .

​
Quick Setup

Follow these steps to get Splat configured:
1

Create environment file

Create a .env file in your project root or home directory:
touch .env
2

Get Groq API key

  1. Visit Groq Console
  2. Sign up or log in to your account
  3. Navigate to API Keys section
  4. Create a new API key
  5. Copy the key (you won’t be able to see it again)
Keep your API key secure and never commit it to version control.
3

Configure environment variables

Add your Groq API key to the .env file:
API=your_groq_api_key_here
MODEL=llama3-70b-8192
API_KEY=your_groq_api_key_here
See Environment Variables for complete reference.
4

Verify setup

Test your configuration by running Splat:
splat
If configured correctly, you should see the interactive CLI prompt.

​
Configuration File Location

Splat uses python-dotenv to load environment variables. The .env file can be placed in:
  • Project directory: .env in your current working directory (recommended for project-specific settings)
  • Home directory: ~/.env for global settings
Project-level .env files take precedence over home directory configuration.

​
Verify Installation

Check that Splat is properly installed and configured: 
splat version
You should see: 
Zap CLI v0.1.0

​
Security Best Practices

Never commit your .env file or API keys to version control.
Add .env to your .gitignore:
.gitignore
# Environment variables
.env
.env.local
.env.*.local

​
Additional Security Tips

Use environment-specific files

Create separate .env.development and .env.production files for different environments.

Rotate API keys regularly

Periodically regenerate your Groq API keys in the console.

Limit key permissions

Use API keys with minimal required permissions.

Monitor usage

Track your API usage in the Groq Console to detect unauthorized access.

​
Troubleshooting

​
API Key Not Found

If you see errors about missing API keys:
  1. Verify your .env file exists and contains the API variable
  2. Check that the .env file is in the correct directory
  3. Ensure there are no extra spaces around the = sign
  4. Restart your terminal session to reload environment variables

​
Permission Errors

If you encounter permission errors: 
chmod 600 .env
This ensures only you can read/write the configuration file.

​
Next Steps

Environment Variables

Complete reference for all configuration options

Groq API

Learn about Groq API configuration and models

Quickstart

Start using Splat to debug your code

Commands

Explore available CLI commands

Build docs developers (and LLMs) love

Get started for freeTalk to us