Skip to content

jchook/shhh

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Shhh!

Get alerts when you are too loud.

About

This app monitors the microphone input on your computer and plays a "SHHH!" sound when you exceed a certain decibel threshold.

Install

Download the binary for your platform and add it to your PATH:

OR, if you have the Rust toolchain installed:

cargo install shhh

Getting Started

Calibrate for your microphone and environment:

shhh calibrate

Then just run it:

shhh

Advanced Usage

Generate a commented config file:

shhh init

Select a specific input device:

shhh devices

Configuration

Settings can be passed as CLI flags, environment variables, or in a config file. CLI flags take precedence over env vars, which take precedence over the config file.

Config file locations:

  • Linux: ~/.config/shhh/shhh.toml
  • macOS: ~/Library/Application Support/shhh/shhh.toml
  • Windows: C:\Users\<User>\AppData\Roaming\shhh\shhh.toml

Run shhh --help for all available options.

Setting Flag Env Var Default Description
alert_frequency -f SHHH_ALERT_FREQUENCY 1 Time between alerts (seconds)
decibel_threshold -t SHHH_DECIBEL_THRESHOLD -35.0 dB threshold for an alert
sensitivity -s SHHH_SENSITIVITY 0.8 0 = sustained loudness, 1 = spikes
notify -n SHHH_NOTIFY true Enable system notifications
verbose -v SHHH_VERBOSE 0 Verbosity level
device -d SHHH_DEVICE Input device (substring match)
alert -a SHHH_ALERT Custom alert sound (WAV, FLAC, OGG, MP3)

Linux Note

Audio on Linux currently goes through ALSA, which works for most setups via PulseAudio/PipeWire compatibility layers. Device names may appear as raw ALSA identifiers. Native PipeWire and PulseAudio support is coming in an upcoming release of cpal, which will bring cleaner device names and better integration.

License

MIT.

About

Shh! Alerts you when you are too loud.

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages