Home

LogViewer Documentation

Welcome to the LogViewer documentation! LogViewer is a unified CLI tool for querying logs from multiple sources with a single, consistent interface.

What is LogViewer?

LogViewer solves the problem of managing logs scattered across multiple systems—Kubernetes, CloudWatch, Splunk, Docker, SSH servers, and more. Instead of learning different CLI tools and query syntaxes for each platform, LogViewer provides:

• One CLI for all log sources - Query K8s, Docker, Splunk, OpenSearch, CloudWatch, and SSH with the same commands
• Unified query syntax - Learn once, use everywhere
• Powerful field extraction - Turn unstructured logs into searchable fields using regex
• Flexible output formatting - Custom templates for human-readable or machine-parseable output
• AI integration - Use as an MCP server with Claude, Copilot, or Gemini for natural language log queries

Quick Navigation

Getting Started

• Installation - Install via Homebrew, Scoop, Docker, or build from source
• CLI-Usage - Basic usage, time filtering, and output formatting
• Configuration - Set up your config file with clients and contexts

Core Features

• Field-Extraction - Extract structured fields from unstructured logs
• Templates - Format output with Go templates
• Variables - Dynamic context variables
• Multi-Context-Search - Query multiple sources simultaneously
• Shell-Completion - Tab completion for all shells

Log Sources (Backends)

• Backends - Detailed setup for each backend:
  • Backends#kubernetes
  • Backends#docker
  • Backends#ssh / Backends#local-commands
  • Backends#opensearch--elasticsearch
  • Backends#splunk
  • Backends#aws-cloudwatch

AI Integration

• MCP-Integration - Set up the MCP server for AI agents
• LLM-Usage-Guide - How AI agents can effectively use LogViewer tools

Help

• Troubleshooting - Common issues and solutions
• FAQ - Frequently asked questions

Example: Your First Query

# Install
brew install bascanada/tap/logviewer

# Interactive configuration wizard
logviewer configure

# Query logs from your configured context
logviewer -i my-app --last 10m query log

Getting Help

• GitHub Issues: Report bugs or request features
• Discussions: Ask questions and share tips

License

LogViewer is open source under the GNU General Public License v3.0.