https://github.com/handstandsam/saydle
"Saydle 🔊", real-time audio notifications for Gradle.
https://github.com/handstandsam/saydle
Last synced: 12 months ago
JSON representation
"Saydle 🔊", real-time audio notifications for Gradle.
- Host: GitHub
- URL: https://github.com/handstandsam/saydle
- Owner: handstandsam
- License: apache-2.0
- Created: 2021-12-03T15:36:11.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-30T15:42:02.000Z (over 2 years ago)
- Last Synced: 2025-04-05T04:32:03.372Z (over 1 year ago)
- Language: Shell
- Homepage:
- Size: 201 KB
- Stars: 93
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Saydle 🔊 - "Say Gradle"
Saydle is a Wrapper for the Gradle Wrapper that notifies you via the OSX [`say`](https://ss64.com/osx/say.html) command whether a task failed or succeeded.
# Why?
Knowing when a Gradle build is done is super helpful when there are long running tasks. This allows you to be notified instead of checking the terminal.
[](https://twitter.com/HandstandSam/status/1463207029007339520)
# System Requirements
* You must be Running Mac OSX
# Installation Instructions
Run the following command from the terminal in the root of your Android Project (where the `gradlew` file is)
```
curl -O "https://raw.githubusercontent.com/handstandsam/saydle/main/saydlew" && chmod +x saydlew
```
This will download the [`saydlew`](https://github.com/handstandsam/saydle/blob/main/saydlew) file and put it next to your `gradlew` file in the root of your Gradle project. It then ensures there is permission to execute the file.
# Usage
* Instead of using `./gradlew`, use `./saydlew` instead. That's it!
* Example: `./saydlew app:assembleDebug`
# Advanced Configuration Options
You can edit these options in the `saydlew` file itself.
* success_phrase="Success"
* failed_phrase="Failed"
* voice="Alex"
## Alternate Voices for the "say" Command
[OSX Say Command Documentation](https://ss64.com/osx/say.html)
**Available English Speaking Voices**
```
Alex en_US # Most people recognize me by my voice.
Fred en_US # I sure like being inside this fancy computer
Samantha en_US # Hello, my name is Samantha. I am an American-English voice.
Victoria en_US # Isn't it nice to have a computer that will talk to you?
```
**Other Languages**
Find other voices by running: `say -v '?'`
# How Does Saydle 🔊 Work?
Saydle 🔊 forwards your command to Gradle, and then looks at the execution result to say either "Success" or "Failed".
