https://github.com/joshi4/splash
Add color to your logs
https://github.com/joshi4/splash
List: splash
awesome brew charmbracelet cli color go logs
Last synced: 5 months ago
JSON representation
Add color to your logs
- Host: GitHub
- URL: https://github.com/joshi4/splash
- Owner: joshi4
- License: mit
- Created: 2025-07-20T08:26:36.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-08-13T05:24:03.000Z (5 months ago)
- Last Synced: 2025-08-16T03:31:52.448Z (5 months ago)
- Topics: awesome, brew, charmbracelet, cli, color, go, logs
- Language: Go
- Homepage:
- Size: 8.97 MB
- Stars: 66
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Splash adds beautiful, adaptive colors to make logs easier to read.
## Features
- **Auto-detection** of 14+ popular log formats including Java and Python stack traces
- **Mixed formats** - handles multiple log formats in a single stream
- **Search highlighting** with string or regex patterns
- **Adaptive colors** that work with both light and dark terminals
- **Streaming performance** - processes logs in real-time
- **Zero configuration** - No config. Just pipe.
## Screenshots
Splash supports many standard log formats and output from popular languages like go (test logs), java (exceptions), and python (tracebacks)
go test -v ./...
go test -v ./... | splash
Syslog Logs
Scan for strings easily with splash --search
Apache format logs
splash -r "08:3\d" to highlight all timestamps that match the regex pattern
## Installation
### Install from Homebrew (Recommended)
```bash
brew tap joshi4/splash
brew install splash
```
### For Linux users
```bash
curl -fsSL https://install.getsplash.sh | sh
```
### For Go users
```bash
go install github.com/joshi4/splash@latest
```
## Get Started
The easiest way to use Splash is to pipe any log output through it:
### Basic Usage
```bash
echo '{"timestamp":"2025-01-19T10:30:00Z","level":"ERROR","message":"Connection failed","service":"api"}' | splash
```
### Highlight errors
```bash
{ echo '{"level":"INFO","msg":"Starting up"}'; echo '{"level":"ERROR","msg":"Connection failed"}'; echo '{"level":"WARN","msg":"Slow query"}'; } | splash -s "ERROR"
```
### Create HTTP logs and highlight error status codes
```bash
{ echo '192.168.1.1 - - [19/Jan/2025:10:30:00 +0000] "GET /api HTTP/1.1" 200 1234'; echo '192.168.1.2 - - [19/Jan/2025:10:30:01 +0000] "POST /api HTTP/1.1" 404 567'; } | splash -r "[45]\d\d"
```
### Generate and monitor continuous output
```bash
while true; do echo "$(date -Iseconds) INFO Server is healthy"; sleep 2; done | splash
```
### Create a mix of log formats to test detection
```bash
{
echo 'Jan 19 10:30:00 localhost myapp[1234]: INFO Application started'
echo '{"timestamp":"2025-01-19T10:30:01Z","level":"WARN","message":"High memory usage"}'
echo '127.0.0.1 - - [19/Jan/2025:10:30:02 +0000] "GET /health HTTP/1.1" 200 15'
} | splash
```
### Use with curl to monitor API responses (requires jq)
```bash
curl -s httpbin.org/json | jq -c . | splash
```
## 🔧 Command Line Options
```bash
splash [flags]
Flags:
-s, --search string Highlight lines containing this text
-r, --regexp string Highlight lines matching this regex pattern
-h, --help Show help information
```
**Note:** You cannot use both `-s` and `-r` flags simultaneously.
## Supported Log Formats
Splash automatically detects and colorizes these log formats:
| Format | Example |
|--------|---------|
| **JSON** | `{"timestamp":"2025-01-19T10:30:00Z","level":"ERROR","message":"DB failed"}` |
| **Logfmt** | `timestamp=2025-01-19T10:30:00Z level=error msg="DB failed" service=api` |
| **Apache Common** | `127.0.0.1 - - [19/Jan/2025:10:30:00 +0000] "GET /api HTTP/1.1" 200 1234` |
| **Nginx** | `127.0.0.1 - - [19/Jan/2025:10:30:00 +0000] "GET /api HTTP/1.1" 200 1234 "-" "Mozilla/5.0"` |
| **Syslog** | `Jan 19 10:30:00 hostname myapp[1234]: ERROR: Database connection failed` |
| **Rsyslog** | `Aug 8 00:15:23 your-macbook-pro syslogd[347]: ASL Sender Statistics` |
| **Go Standard** | `2025/01/19 10:30:00 ERROR: Database connection failed` |
| **Rails** | `[2025-01-19 10:30:00] ERROR -- : Database connection failed` |
| **Docker** | `2025-01-19T10:30:00.123456789Z ERROR Database connection failed` |
| **Kubernetes** | `2025-01-19T10:30:00.123Z 1 main.go:42] ERROR Database connection failed` |
| **Heroku** | `2025-01-19T10:30:00+00:00 app[web.1]: ERROR Database connection failed` |
| **Go Test** | `=== RUN TestDatabaseConnection` |
| **Java Exception** | `Exception in thread "main" java.lang.ArithmeticException: / by zero` |
| **Python Exception** | `Traceback (most recent call last):` |
## Build from Source
```bash
git clone https://github.com/joshi4/splash.git
cd splash
go build
```
## FAQ
**I'm using a supported log format but it's not being detected. What should I do?**
Sometimes logs are written to stderr instead of stdout. Try redirecting stderr to stdout:
```bash
your_command 2>&1 | splash
```
## Contributing
1. Fork the repository
2. Create a feature branch: `git checkout -b feature-name`
3. Make your changes and add tests
4. Run tests: `go test ./...`
5. Submit a pull request