https://github.com/madhavjivrajani/halp
Display a message in morse code on your capslock LED, keyboard backlight or using your screen brightness!
https://github.com/madhavjivrajani/halp
cli golang linux morse-code systems
Last synced: over 1 year ago
JSON representation
Display a message in morse code on your capslock LED, keyboard backlight or using your screen brightness!
- Host: GitHub
- URL: https://github.com/madhavjivrajani/halp
- Owner: MadhavJivrajani
- License: apache-2.0
- Created: 2021-01-08T18:26:56.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-01-25T06:16:13.000Z (over 5 years ago)
- Last Synced: 2025-03-14T17:46:27.655Z (over 1 year ago)
- Topics: cli, golang, linux, morse-code, systems
- Language: Go
- Homepage:
- Size: 578 KB
- Stars: 27
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# halp
`halp` is a command line utility that lets you display messages in morse code on your capslock LED, keyboard backlight (if you have it) or using your screen's brightness!
### Note:
`halp` will only work if you're running Linux. The original purpose of developing this was to learn more about the concept of 'everyhting in linux is a file' and learn more about how permissions in linux work. The idea originated after watching [this](https://www.youtube.com/watch?v=Z56Jmr9Z34Q&feature=emb_title) video.
## Installation
Use the executable:
```
curl -sSL https://github.com/MadhavJivrajani/halp/releases/download//halp --output halp
chmod +x halp
mv halp /usr/bin # to make the executable available system wide
```
Installation can also done using the `go get` command which will take care of installation of any libraries and dependencies nescessary. This will also install the `halp` executable which can be used anywhere in the termnial provided `$GOPATH/bin` is in your `PATH`.
```
go get -u github.com/MadhavJivrajani/halp
```
Or you can clone this repository and work directly with the `halp` executable!
```
git clone https://github.com/MadhavJivrajani/halp.git
cd halp
go build -o halp main.go
mv halp /usr/bin # to make the executable available system wide
```
## Usage:
```
A verryyy normal and usual application built to help you send SoS messages.
The tool will by default switch off the LED before displaying the morse code
message and will restore it back to this initial state when the message finishes displaying
Syntax:
halp -m
Usage:
halp [flags]
halp [command]
Available Commands:
help Help about any command
reset Reset the resource state to 'value'
Flags:
--config string config file (default is $HOME/.halp.yaml)
-h, --help help for halp
-k, --keyboard use keyboard backlight
-m, --message string message to diplay in morse code
-p, --path string /path/to/capslockLED (default "/sys/class/leds/input3::capslock")
-s, --screen use screen backlight
Use "halp [command] --help" for more information about a command.
```
## Commands:
### `reset`
```
It will default to a capslock LED path, you can try using the -s and the -k flags,
to reset to value for screen and keyborad resources respectively
Syntax:
halp reset [--keyboard][--screen][--path][--value]
Usage:
halp reset [flags]
Flags:
-h, --help help for reset
-k, --keyboard reset keyboard backlight
-p, --path string /path/to/resource (default "/sys/class/leds/input3::capslock")
-s, --screen reset screen backlight
-v, --value int reset the resource to this value
```
## Disclaimer
### I am not responsible for anything going wrong with the system `halp` is run on, this is an educational project.