cloudwatch-logs-cli
v1.0.1
Published
A professional CLI tool to read AWS CloudWatch logs from the console.
Downloads
10
Maintainers
Readme
CloudWatch Logs CLI 📊
Tired of logging into CloudWatch via the web or using AWS commands to view logs? 😓 Want a simpler, faster way to do it?
Introducing CloudWatch Logs CLI! 🚀 This CLI tool lets you read and stream CloudWatch logs directly from your terminal. Just select the log group and stream logs in real-time. Perfect for quick monitoring and debugging, all from your terminal.
Features ✨
- AWS Configuration Check: Ensures your AWS credentials are set and valid before proceeding.
- Region Selection: Choose your AWS region for fetching logs.
- Log Group Navigation: Easily navigate through your log groups, including sub-groups.
- Date Filtering: Filter log groups by creation date (all, this year, this month, today).
- Real-Time Streaming: Stream logs in real-time, updating every 2 seconds.
- Back Navigation: Seamlessly navigate back to previous menus.
- Credentials Handling: Handles expired or invalid tokens, prompting for new credentials when needed.
- User-Friendly Interface: Simple and intuitive prompts to guide you through the process.
Installation 📦
Make sure you have Node.js (version 18 or higher) installed.
npm install -g cloudwatch-logs-cli
Usage 🚀
Start the CLI:
cwlogs logs
Follow the prompts to:
- Ensure your AWS credentials are configured.
- Select your AWS region.
- Navigate through log groups.
- Stream logs in real-time.
Stop Streaming:
Press q
to stop streaming logs and navigate back.
Prerequisites 🛠
- AWS credentials (Access Key ID, Secret Access Key, and optionally Session Token)
- AWS IAM permissions to access CloudWatch logs
Example Commands 🌟
# Start the CLI tool
cwlogs logs
Important Notes 📌
Ensure your AWS credentials are configured. You can provide these when prompted or set them as environment variables:
export AWS_ACCESS_KEY_ID="your-access-key-id"
export AWS_SECRET_ACCESS_KEY="your-secret-access-key"
export AWS_SESSION_TOKEN="your-session-token" # if applicable
Dependencies 📚
License 📄
This project is licensed under the MIT License.
Author 👨💻
Developed with ❤️ by Alberto Linde
For any queries, you can reach me at [email protected]
Remember: Monitoring your logs is crucial for maintaining robust and reliable systems. Keep coding and keep improving! 🖥️💪