Skip to content

VladCuciureanu/Wren

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wren

Ambient sound from your CI pipeline. Green builds = birdsong. Failing tests = distant thunder. Deployment in progress = low hum. Your office becomes a weather system controlled by your codebase.

Requirements

Install

# macOS
brew install deno ffmpeg

# Linux
# Install Deno: https://deno.land/#installation
sudo apt install ffmpeg   # Debian/Ubuntu

Quick Start

# Generate a config file
deno task start init

# Edit the config to add your repos
# (uses your default editor, or open manually)
$EDITOR ~/.config/wren/config.toml

# Run
deno task start

Config

Config lives at ~/.config/wren/config.toml (respects XDG_CONFIG_HOME).

[general]
poll_interval = 45   # seconds (minimum 10)
volume = 80          # 0–100
theme = "forest"     # sound theme

[[repos]]
owner = "your-org"
name = "your-repo"
provider = "github"
token = "ghp_..."    # or omit to use GITHUB_TOKEN env var

[[repos]]
owner = "your-org"
name = "another-repo"
provider = "github"

Sound Mapping (Forest Theme)

Pipeline State Sound
All passing Birdsong, gentle breeze
Tests failing Distant thunder, wind
Build error Rain, close thunder
Deploying Low hum, rustling
Deploy succeeded Melodic chime → birdsong
Deploy failed Thunder crack → steady rain
Queued / pending Soft wind, ambient drone
Disconnected Faint static

Multiple repos blend linearly — one failing repo darkens the mood without fully overriding passing ones.

Keybindings

Key Action
q Quit
m Toggle mute
+ Volume up
- Volume down

CLI Options

wren [OPTIONS]
wren init

Options:
  -c, --config <path>   Path to config.toml
  --volume <0-100>      Override volume
  -m, --mute            Start muted
  -v, --version         Print version
  -h, --help            Print help

Development

# Run tests
deno task test

# Type check
deno task check

# Format
deno task fmt

# Lint
deno task lint

About

🪶 Your CI pipeline, heard not watched. Birdsong for green builds, thunder for failures — Turn your code into weather.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors