{"id":26385273,"url":"https://github.com/madhavjivrajani/halp","last_synced_at":"2025-03-17T07:41:25.142Z","repository":{"id":54855173,"uuid":"327981652","full_name":"MadhavJivrajani/halp","owner":"MadhavJivrajani","description":"Display a message in morse code on your capslock LED, keyboard backlight or using your screen brightness!","archived":false,"fork":false,"pushed_at":"2021-01-25T06:16:13.000Z","size":592,"stargazers_count":27,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-14T17:46:27.655Z","etag":null,"topics":["cli","golang","linux","morse-code","systems"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MadhavJivrajani.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-08T18:26:56.000Z","updated_at":"2025-01-19T17:51:19.000Z","dependencies_parsed_at":"2022-08-14T04:50:38.251Z","dependency_job_id":null,"html_url":"https://github.com/MadhavJivrajani/halp","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MadhavJivrajani%2Fhalp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MadhavJivrajani%2Fhalp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MadhavJivrajani%2Fhalp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MadhavJivrajani%2Fhalp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MadhavJivrajani","download_url":"https://codeload.github.com/MadhavJivrajani/halp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243996278,"owners_count":20380977,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","golang","linux","morse-code","systems"],"created_at":"2025-03-17T07:41:22.306Z","updated_at":"2025-03-17T07:41:25.132Z","avatar_url":"https://github.com/MadhavJivrajani.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# halp\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/ashleymcnamara/gophers/master/WonderWomanGopher.png\" width=\"300\" height=\"300\"\u003e\n\u003c/p\u003e\n\n`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! \n\n### Note:\n`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\u0026feature=emb_title) video.\n\n## Installation\n\nUse the executable:\n```\ncurl -sSL https://github.com/MadhavJivrajani/halp/releases/download/\u003ctag\u003e/halp --output halp\nchmod +x halp\nmv halp /usr/bin # to make the executable available system wide\n```\n\nInstallation 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`.\n\n```\ngo get -u github.com/MadhavJivrajani/halp\n```\n\nOr you can clone this repository and work directly with the `halp` executable!\n```\ngit clone https://github.com/MadhavJivrajani/halp.git\ncd halp\ngo build -o halp main.go\nmv halp /usr/bin # to make the executable available system wide\n```\n\n## Usage:\n```\nA verryyy normal and usual application built to help you send SoS messages.\n\nThe tool will by default switch off the LED before displaying the morse code\nmessage and will restore it back to this initial state when the message finishes displaying\n\nSyntax:\nhalp -m \u003cmessage\u003e\n\nUsage:\n  halp [flags]\n  halp [command]\n\nAvailable Commands:\n  help        Help about any command\n  reset       Reset the resource state to 'value'\n\nFlags:\n      --config string    config file (default is $HOME/.halp.yaml)\n  -h, --help             help for halp\n  -k, --keyboard         use keyboard backlight\n  -m, --message string   message to diplay in morse code\n  -p, --path string      /path/to/capslockLED (default \"/sys/class/leds/input3::capslock\")\n  -s, --screen           use screen backlight\n\nUse \"halp [command] --help\" for more information about a command.\n```\n\n## Commands:\n### `reset`\n```\nIt will default to a capslock LED path, you can try using the -s and the -k flags,\nto reset to value for screen and keyborad resources respectively\n\nSyntax:\nhalp reset [--keyboard][--screen][--path][--value]\n\nUsage:\n  halp reset [flags]\n\nFlags:\n  -h, --help          help for reset\n  -k, --keyboard      reset keyboard backlight\n  -p, --path string   /path/to/resource (default \"/sys/class/leds/input3::capslock\")\n  -s, --screen        reset screen backlight\n  -v, --value int     reset the resource to this value\n```\n\n## Disclaimer\n\n### I am not responsible for anything going wrong with the system `halp` is run on, this is an educational project.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmadhavjivrajani%2Fhalp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmadhavjivrajani%2Fhalp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmadhavjivrajani%2Fhalp/lists"}