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.1.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.1.0-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: buxcli-1.1.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.1.0.tar.gz
Algorithm Hash digest
SHA256 6811928d0e57037ddba53d45e35d74bc2f9117c763b62e1c56097e16e372ea55
MD5 e369373035ded786894be8bdf0b40e6e
BLAKE2b-256 4946ce93867dfa522360cee4337a8c4e1eb6e07bb6103ecf22acc3a5eba517c8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: buxcli-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.4 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 957a56a863ff600569b6ed960b95bcf56faa6b901df997b21a9315716dede483
MD5 1abde7e80c5d0b5f7bc8e8a939ea27f0
BLAKE2b-256 9ea724fb7998c8493f2223bcb9a7cee101b7be3461db416dc9122eb274c5bf35

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