Skip to main content

A simple CLI tool for alert you about your CLI.

Project description

โšก BuxCLI ๐Ÿš€

Run any command + get instant email notifications

BuxCLI is a lightweight command-line tool that runs shell commands and sends instant email alerts when your command:

1๏ธโƒฃ Succeeds
2๏ธโƒฃ Fails
3๏ธโƒฃ Server starts (auto-detects โ€œserver readyโ€ messages)

Perfect for developers, sysadmins, and DevOps engineers who donโ€™t want to stare at terminals.


๐Ÿ“‘ Table of Contents


โœจ Features

  • ๐Ÿ”” Email alerts for success, failure, or server startup
  • ๐Ÿ” Secure Gmail App Password setup
  • ๐Ÿ’ฌ Test email option during initial setup
  • ๐Ÿ”„ Automatic retry if credentials are invalid
  • ๐ŸŽจ Colorful CLI output with ASCII banner
  • ๐Ÿงช Works with all commands (Python, Django, Docker, Node, Bash, etc.)

๐Ÿ’ป Installation

Install using pip:

pip install buxcli

Check Instalation

buxcli --help

Output:

โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ  โ–ˆโ–ˆ    โ–ˆโ–ˆ โ–ˆโ–ˆ   โ–ˆโ–ˆ  โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ โ–ˆโ–ˆ      โ–ˆโ–ˆ 
โ–ˆโ–ˆ   โ–ˆโ–ˆ โ–ˆโ–ˆ    โ–ˆโ–ˆ  โ–ˆโ–ˆ โ–ˆโ–ˆ  โ–ˆโ–ˆ      โ–ˆโ–ˆ      โ–ˆโ–ˆ 
โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ  โ–ˆโ–ˆ    โ–ˆโ–ˆ   โ–ˆโ–ˆโ–ˆ   โ–ˆโ–ˆ      โ–ˆโ–ˆ      โ–ˆโ–ˆ 
โ–ˆโ–ˆ   โ–ˆโ–ˆ โ–ˆโ–ˆ    โ–ˆโ–ˆ  โ–ˆโ–ˆ โ–ˆโ–ˆ  โ–ˆโ–ˆ      โ–ˆโ–ˆ      โ–ˆโ–ˆ 
โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ   โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ  โ–ˆโ–ˆ   โ–ˆโ–ˆ  โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ โ–ˆโ–ˆ 

Run commands with automatic email notifications when they succeed, fail, or a server starts.

Examples:
  buxcli run "python manage.py runserver"
  buxcli docker pull ollama
Usage: buxcli [OPTIONS] [CMD]... COMMAND [ARGS]...

  buxcli - Run commands with automatic email notifications

Options:
  --reconfig  Reconfigure email Credentials
  --help  Show this message and exit.

Commands example:
  buxcli docker pull nginx

๐Ÿ”— Example

1) Long Running Commands

- buxcli docker pull nginx

- buxcli flutter build apk

# send mail on sucess or failure

2) Server Starting commands

- buxcli python manage.py runserver

# send mail on server starting

๐Ÿค Contributing

# 1. Fork the repository

# 2. Create a feature branch
git checkout -b feature/my-feature

# 3. Commit your changes
git commit -m "Add new feature"

# 4. Push to GitHub
git push origin feature/my-feature

# 5. Open a Pull Request

๐Ÿ“ก Contact

Mohd. Rushaad Buxy
Email: m.rushaadq@gmail.com
GitHub: https://github.com/rushaad2911/Buxcli

buxcli โ€“ Never miss a command status again! ๐Ÿš€

๐Ÿ“ License

This project is licensed under the MIT License. See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

buxcli-1.2.0.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

buxcli-1.2.0-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file buxcli-1.2.0.tar.gz.

File metadata

  • Download URL: buxcli-1.2.0.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.0

File hashes

Hashes for buxcli-1.2.0.tar.gz
Algorithm Hash digest
SHA256 2fad05132b41a7804dbde18ff0ac0662cd769851372f44b0ab424407777c857c
MD5 a01246e9fc98e93c4b627229dfa1809a
BLAKE2b-256 c7b67abccb0ccc3fe3789b451a7189f95759a82b052027e39307acc8d36db08e

See more details on using hashes here.

File details

Details for the file buxcli-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: buxcli-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.0

File hashes

Hashes for buxcli-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f5acc9a8956586858cee1c03fa281a1a5c6a5f9052b76ed3355685f9aa0c7a3f
MD5 6095fd3c1c292a366b757ce6760de508
BLAKE2b-256 a0d31242179985345950ab4827e2f1f80c00ab1dc1fed6fe55c0b3391c67e0fd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page