BAMON Documentation

BAMON Logo

📦 BAMON Version 0.0.15

Welcome to the BAMON documentation! BAMON (Bash Daemon Monitor) is a tool for monitoring and executing bash scripts at specified intervals.

Why BAMON?

Countless monitoring tools exist, but BAMON fills a specific gap. We all have those commands we run in the terminal just to check something - maybe a GitHub status check, SSH to a dev VM to check load, or in my case, getting a full overview of multiple non production ArgoCD applications.

The goal of BAMON is simple: when you have a command or script you'd like to run in a repetitive manner, that just needs the context of your user environment, BAMON is the tool for you.

What is BAMON?

BAMON is a lightweight, configurable monitoring solution that runs as a daemon process, continuously monitoring configured scripts and executing them at specified intervals. It provides:

  • Automated Script Execution: Run scripts at configurable intervals
  • Sandboxed Environment: Secure execution with resource limits
  • Performance Monitoring: Built-in system metrics and optimization
  • Flexible Configuration: YAML-based configuration with CLI management
  • Comprehensive Status: Detailed execution history and status reporting

Quick Start

Installation

# Download and install from latest release
curl -sSL https://github.com/WawRepo/bamon/releases/latest/download/install-repo.sh | bash

Basic Usage

# Start the daemon
bamon start --daemon

# Add a monitoring script
bamon add health_check --command "curl -s https://httpbin.org/status/200" --interval 30

# Check status
bamon status

# Execute all scripts immediately
bamon now

# Stop the daemon
bamon stop

Key Features

🔄 Automated Monitoring

Execute scripts at configurable intervals with built-in scheduling.

🛡️ Sandboxed Execution

Secure script execution with resource limits and timeout controls.

📊 Performance Monitoring

Built-in system metrics collection and performance optimization.

⚙️ Flexible Configuration

YAML-based configuration with comprehensive CLI management.

🔍 Comprehensive Status

Detailed execution history, status reporting, and error tracking.

🚀 Easy Installation

One-command installation from GitHub releases with automatic setup.

Documentation Structure

Getting Help

  • Documentation: Browse the sections above for detailed information
  • Issues: Report bugs or request features on GitHub Issues
  • Releases: Check the latest releases for updates

Contributing

We welcome contributions! Please see our GitHub repository for details on how to contribute to BAMON.