https://github.com/dnhn/git-audio

Add a spark of joy to coding: hear a surprise sound every time you commit 🔈
https://github.com/dnhn/git-audio

audio for-the-love-of-code fortheloveofcode git git-hook git-hooks post-commit shell sound terminal

Last synced: about 2 months ago
JSON representation

Add a spark of joy to coding: hear a surprise sound every time you commit 🔈

• Host: GitHub
• URL: https://github.com/dnhn/git-audio
• Owner: dnhn
• License: mit
• Created: 2025-07-22T18:19:14.000Z (11 months ago)
• Default Branch: root
• Last Pushed: 2025-09-20T18:11:25.000Z (9 months ago)
• Last Synced: 2026-04-17T10:22:52.320Z (2 months ago)
• Topics: audio, for-the-love-of-code, fortheloveofcode, git, git-hook, git-hooks, post-commit, shell, sound, terminal
• Language: Shell
• Homepage: https://git-audio.nhan.dev
• Size: 290 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

          


# Git Audio

[![Cover image](./cover.svg)](https://git-audio.nhan.dev)

[![Documentation](https://img.shields.io/badge/Documentation-none?style=for-the-badge&cacheSeconds=86400)](https://git-audio.nhan.dev)

[![License](https://img.shields.io/github/license/dnhn/gca?style=for-the-badge)](./license)

Add a spark of joy to coding: hear a surprise sound every time you commit. By default, it’s a sitcom laugh track.

[For the Love of Code 2025](https://gh.io/ftloc) hackathon entry.



## Features

- Cross-platform:

  - macOS (`afplay`)

  - Linux (`aplay`, `paplay`, `ffplay`)

- Quick setup with a single command!

- Ease of use thanks to simple CLI

## Installation

Make sure you have [Make](https://www.gnu.org/software/make) installed, then run:

```shell

make install

```

That’s it! You can now use the `git-audio` command.

## Usage

### Per-repository

1. Install the hook into a repository

   ```shell

   git-audio repo:commit

   ```

1. Commit!

### Global

1. Run

   ```shell

   git-audio global:commit

   ```

1. `git init` or `git clone` as usual

1. Commit!

## Configuration

Configuration files are stored in `$HOME/.git-audio/`

```

$HOME/.git-audio/

  ├─ audio.wav

  ├─ cli.sh

  ├─ config.sh

  └─ templates

      └─ hooks

          └─ post-commit

```

To change the audio, run:

```shell

git-audio audio:set /path/to/your/audio

```

## Documentation

See the [documentation](https://git-audio.nhan.dev) for complete instructions.

## Thanks

- :copilot: [GitHub Copilot](https://gh.io/copilot) for co-piloting

- 🔈 [Freesound](https://freesound.org/s/324894) for the audio

- 📔 [og.new](https://og.new) for the cover image