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.1.tar.gz (6.1 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.1-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: buxcli-1.2.1.tar.gz
  • Upload date:
  • Size: 6.1 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.1.tar.gz
Algorithm Hash digest
SHA256 03d57eb5be74ac99eac5da0c5771d3095dc389140b6843807f0be584ce0e8a90
MD5 5a67fb7ecb125435e9bb1d4d38da1ed3
BLAKE2b-256 8115bc3612662c528e84561e570b74856d2ac1cdb97b28a292e30a8fc31b875b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: buxcli-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 7.5 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 86a0aa63e391e415b16e5a79d5c10e755506f9060b57d0c13690d1d54dc169e6
MD5 cb94a0be87adb6e82ec129dc1f33d118
BLAKE2b-256 05fa414e23f9162b85fa64b9f4f4e630cba0b9263ccb5c75fee0a10b78199e00

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