Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 1.86 KB

README.md

File metadata and controls

51 lines (37 loc) · 1.86 KB
Raw

A simple terminal application written in Go for sending SMS messages using the 46 Elks API.

This project has nothing to do with the 46 Elks company, and is not supported of affiliated with them in any way.

Screenshot of the TUI variant for manually sending a text ... or by simply ./elks --from "SenderID" --to "+46700000000" --text "Hello world!"

Compile

Navigate to the project directory and run the following command to compile the program. This will create an executable file named elks.

go build main.go -o elks

Run

To run the program, simply type the name of the executable file.

./elks

Usage

The program will ask you for your 46 Elks API credentials. You can find them on the API account page. This will be needed to send SMS messages, and the program will not work without them.

Set your 46 Elks username and password as environment variables:

Unix/Linux:

export 46ELKS_API_USERNAME=yourusername
export 46ELKS_API_PASSWORD=yourpassword
./elks --from "SenderID" --to "+46700000000" --text "Hello world!"

Windows (PowerShell):

$env:46ELKS_API_USERNAME = 'yourusername'
$env:46ELKS_API_PASSWORD = 'yourpassword'
./elks.exe --from "SenderID" --to "+46700000000" --text "Hello world!"

License

This project is licensed under the MIT License—see the LICENSE file for details

Acknowledgments

  • 46 Elks.se - provides a great API for sending SMS messages.
  • Golang.org - a great programming language.
  • huh @ github - a great library for creating terminal user interfaces. With great documentations and examples.
  • bubbletea @ github - a great library for creating terminal user interfaces. With great documentations and examples.