Surge ·

Development in Progress

Surge is an upcoming CLI tool for real‑time system and network monitoring, with planned support for chaos engineering and stress testing. It centralizes Linux tools like curl, netstat, iostat, top, and more into one clear interface with robust, actionable summaries and tabular/graphical output.

• Declarative Monitoring: Run simple, clear commands to get formatted, real‑time metrics for CPU, RAM, network, APIs, and more. Declarative output makes your monitoring predictable, easy to interpret, and actionable.
• Component‑Like Commands: Separate modules for system health, network tests, plotting graphs, and (future) load/chaos scenarios.
• Learn Once, Run Anywhere: Works in local, VPS, and production environments. Portable via Docker or direct CLI install.

Roadmap

• Build a CLI interface that retrieves metrics on CPU, RAM, Disk/IO, and Network (Mostly Complete)
• Implement a suite of commands to test API endpoints
• Render simple, insightful graphs in the CLI
• Add a config file and scheduler for integration with CI/CD pipelines
• Dockerized deployment for easy setup
• Add an LLM integration for summaries via LangChain (Mostly Complete)
• (Future) Chaos engineering and stress testing capabilities
• (Future) Alerts, logging via email/SMS, continuous monitoring

Installation

Currently, Surge is set to run via Docker, through the Python programming language. We plan to support direct CLI installs and publish to PyPI if the project gains traction.

Clone the Repository

git clone https://github.com/SurgeCLI/Surge.git # HTTPS
git clone git@github.com:SurgeCLI/Surge.git     # SSH

Set Up Docker

Install Docker Engine if you haven't already. Once complete, run the following to build the image.

docker build -t surge:latest .

To run the container once, use the following command below with specified CLI arguments as needed.

docker run --rm surge:latest [command] [options]

Set Up a Virtual Environment

If you prefer using a virtual environment to run the necessary dependencies, enter the following in your terminal with Python 3.12 or above:

python -m venv venv

source venv/bin/activate # Linux/Mac
.\venv\Scripts\activate  # Windows

pip install -r cli/requirements.txt

Be sure to use Linux with the installed packages found in the Dockerfile to avoid errors running subprocess commands locally.

Examples and Documentation

More detailed documentation, demos, and visuals will be released with the MVP (coming soon).

Contributing

Check out CONTRIBUTING.md for guidelines.

License

Surge is MIT licensed.