Skip to main content

A CLI tool for extracting AWS metrics and managing resources

Project description

AWS Vibe Guru 🔧

A powerful command-line interface (CLI) tool for managing AWS resources and extracting metrics. Currently supports Amazon SQS queue monitoring and Amazon S3 bucket operations.

✨ Quick Overview

AWS Vibe Guru provides intuitive commands to interact with AWS services directly from your terminal, with beautiful visual output and comprehensive analytics.

Current Features

  • 📊 SQS Monitoring: Queue management, message volume tracking, age monitoring, and advanced analytics
  • 📦 S3 Operations: Bucket management, object listing, file reading with JSON formatting
  • 🎨 Beautiful Output: Rich terminal formatting with colors, charts, and panels
  • 📈 Analytics: Statistical analysis with charts, trends, and comparisons

🚀 Quick Start

Installation

curl -LsSf https://astral.sh/uv/install.sh | sh
git clone https://github.com/daniellbastos/aws-vibe-guru.git
cd aws-vibe-guru
uv sync

Basic Usage

aws-vibe-guru sqs-list-queues
aws-vibe-guru sqs-analyze-volume "my-queue" --days 30

aws-vibe-guru s3-list-buckets
aws-vibe-guru s3-read-object "my-bucket" "config.json" --json

AWS Credentials

Configure credentials via ~/.aws/credentials file or environment variables:

export AWS_ACCESS_KEY_ID="your_access_key"
export AWS_SECRET_ACCESS_KEY="your_secret_key"
export AWS_DEFAULT_REGION="us-east-1"

📚 Complete Documentation

For detailed information about all commands, parameters, return values, and examples:

👉 Read the Full Technical Reference

The reference documentation includes:

  • All 9 available commands (5 SQS + 4 S3)
  • Detailed parameter descriptions
  • Usage examples for each command
  • Return value structures
  • AWS permissions required
  • Configuration guide

📋 Available Commands

SQS Commands

  • sqs-list-queues - List all SQS queues with optional filtering
  • sqs-get-attributes - Get comprehensive queue attributes
  • sqs-get-metrics - Get message volume metrics with charts
  • sqs-get-oldest-message - Monitor oldest message age
  • sqs-analyze-volume - Advanced statistical analysis

S3 Commands

  • s3-list-buckets - List all S3 buckets
  • s3-list-objects - List objects in a bucket (with prefix filter and summary mode)
  • s3-get-object - Get detailed object information
  • s3-read-object - Read and display file content (with JSON formatting)

Run aws-vibe-guru --help to see all available commands.

🎥 Demo

https://github.com/user-attachments/assets/1ad28f09-05c4-4dc6-b2ef-9e174da47b08

🛠️ Development

git clone https://github.com/daniellbastos/aws-vibe-guru.git
cd aws-vibe-guru
uv sync --extra dev
make pre-commit-install
make quality

Development Commands

  • make quality - Run linting and formatting
  • make lint - Check code with Ruff
  • make format - Format code with Ruff

📦 Requirements

  • Python 3.8.1 or higher
  • AWS credentials configured
  • UV package manager (recommended)

🙏 Built With

  • boto3 - AWS SDK for Python
  • Typer - CLI framework
  • Rich - Terminal formatting
  • UV - Package manager
  • Ruff - Linter and formatter

📄 Documentation & Release Notes

📄 License

MIT License - see the LICENSE file for details.

🔗 Links


Made with ❤️

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

aws_vibe_guru-0.1.2.tar.gz (15.1 kB view details)

Uploaded Source

Built Distribution

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

aws_vibe_guru-0.1.2-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

Details for the file aws_vibe_guru-0.1.2.tar.gz.

File metadata

  • Download URL: aws_vibe_guru-0.1.2.tar.gz
  • Upload date:
  • Size: 15.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.2

File hashes

Hashes for aws_vibe_guru-0.1.2.tar.gz
Algorithm Hash digest
SHA256 2aaac9d90fb1ebb6aa5b306c8213d77d03768be33a98ddb8dc7d039dbe83c91d
MD5 e118e53915bba78a6098ce1a99642656
BLAKE2b-256 e44d70bb0407002d8de58c31ac46652045a629bb377179986bfa366660da9af5

See more details on using hashes here.

File details

Details for the file aws_vibe_guru-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: aws_vibe_guru-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 15.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.2

File hashes

Hashes for aws_vibe_guru-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b36f2d56c08f9c6196400cb248fd4641bdf87f09742f24852249bcc0de396b92
MD5 697814da5126720ad312798fb7c03b08
BLAKE2b-256 250773b9e1dcb84bc822fcce84327cf77cf6481accf79ce1b72d0183fb4bcf50

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