Dashboard

LogFlux Client Tools

LogFlux Clients are tools that run on your machine to query, decrypt, and analyze your encrypted logs. All decryption happens locally — the LogFlux backend never sees your plaintext data.

Clients authenticate with a Personal Access Token (PAT) and use your RSA private key for local decryption.

LogFlux Inspector CLI

💻

LogFlux Inspector CLI

Powerful command-line tool for log analysis, automation, and scripting workflows.

Best for: DevOps, CI/CD, automation, scripting, server environments

View Documentation →

Grafana Integration

The recommended way to visualize and analyze your LogFlux data is through the Grafana datasource plugin, powered by the LogFlux API Server running locally.

📊

Grafana Datasource Plugin

Visualize and query your encrypted logs directly in Grafana. All decryption happens locally via the LogFlux API Server — zero-knowledge architecture preserved.

Architecture: Grafana UI → Grafana Plugin → LogFlux API Server (port 8383) → DuckDB/Backend

LogFlux API Server

The LogFlux API Server runs locally on port 8383 and serves as the bridge between Grafana and the LogFlux backend:

  • Connects to the LogFlux backend via Personal Access Token (PAT) for data retrieval
  • Decrypts all log data locally using your RSA private key
  • Serves decrypted data to Grafana for visualization
  • All analysis happens client-side (zero-knowledge preserved)

Key Features

The LogFlux CLI provides these core capabilities:

Advanced Log Analysis

  • Encrypted Log Access: Decrypt and analyze logs locally for complete privacy
  • Complex Search: Advanced filtering with regex, time ranges, and field-specific queries
  • Real-time Streaming: Monitor live logs with customizable filters and alerts
  • Multi-format Export: Export to JSON, CSV, plain text, and formatted reports

Authentication & Security

  • Personal Access Tokens: Secure authentication using PATs from the LogFlux dashboard
  • Local Decryption: All log decryption happens locally on your system
  • Private Key Management: Secure handling of RSA private keys for encryption
  • Zero Trust Architecture: No plaintext logs transmitted over the network

Performance & Scalability

  • Efficient Processing: Optimized for handling large volumes of encrypted logs
  • Batch Operations: Process multiple operations in parallel
  • Caching: Smart caching for improved performance on repeated queries
  • Resource Management: Configurable memory and CPU usage limits

When to Use LogFlux CLI

The LogFlux Inspector CLI is ideal for:

  • Automation & Scripting: Scripting log analysis tasks and workflows
  • CI/CD Integration: Incorporating log analysis into pipelines
  • Server Environments: Working on headless servers and remote systems
  • High Performance: Processing very large datasets efficiently
  • Scheduling: Running periodic analysis jobs via cron
  • Remote Access: Working over SSH connections
  • DevOps Workflows: Integrating with existing command-line tools

Common Workflows

Security Incident Investigation

  1. CLI: Search for security events and anomalies with time filters
  2. CLI: Export relevant logs for detailed forensic analysis
  3. CLI: Generate incident reports and summaries
  4. CLI: Automated alerting on suspicious patterns

DevOps Monitoring

  1. CLI: Automated alerting on error patterns via cron jobs
  2. CLI: Scheduled health checks and system monitoring
  3. CLI: Scheduled exports for compliance and archival
  4. CLI: Integration with monitoring systems and alerting tools

Compliance & Auditing

  1. CLI: Automated compliance report generation
  2. CLI: Scheduled audit log collection and verification
  3. CLI: Bulk export of logs for regulatory submissions
  4. CLI: Automated verification of access patterns and security events

Installation

For complete installation instructions, see the Installation Guide.

The LogFlux CLI is available for download:

  1. Contact LogFlux support for CLI access
  2. Select your platform and architecture
  3. Follow platform-specific installation steps

Supported Platforms

  • All Platforms: macOS (Intel & Apple Silicon), Linux (x86_64, ARM64), Windows (x86_64)
  • Cross-platform binaries: Single executable for each platform

Authentication Setup

For complete authentication setup, see the Authentication Guide.

The CLI uses Personal Access Tokens (PATs) and RSA private keys:

  1. Generate a PAT for CLI access
  2. Configure authentication in the CLI
  3. Set up your RSA private key for log decryption
  4. Verify setup with test commands

Environment variables work with the CLI:

1
2

export LOGFLUX_PAT="eu-lf_usr_your_token_here"
export LOGFLUX_PRIVATE_KEY_FILE="~/.logflux/private_key.pem"

Integration Possibilities

CLI Integration

  • Shell Scripts: Incorporate into bash/PowerShell scripts
  • CI/CD Pipelines: GitHub Actions, Jenkins, GitLab CI
  • Monitoring Systems: Nagios, Zabbix, Prometheus alerting
  • Cron Jobs: Scheduled analysis and reporting
  • Automation Tools: Ansible, Terraform, configuration management
  • Log Processing Pipelines: Custom data processing workflows

Best Practices

For security guidelines, see Security Best Practices. For standard configuration patterns, see Configuration Examples.

CLI Usage Best Practices

Performance

  • Time Filtering: Always use specific time ranges to limit data volume
  • Result Limits: Set appropriate limits for large queries
  • Local Caching: Enable caching for frequently accessed data
  • Resource Planning: Allocate sufficient CPU and memory for large operations

Workflow

  • Automation Focus: Automate routine tasks and monitoring
  • Script Documentation: Document common queries and analysis patterns
  • Team Training: Ensure team members are proficient with CLI usage
  • Integration Planning: Plan CLI integration with existing toolchains

Next Steps

  • Get Started: Follow the CLI installation guide
  • Learn the Basics: Start with simple searches and exports
  • Explore Automation: Discover scripting and automation capabilities
  • Integrate Workflows: Incorporate LogFlux CLI into your existing processes