Dashboard GitHub

Installation

Install the LogFlux Collector CLI

This guide covers installing the LogFlux Collector CLI for sending logs to LogFlux servers.

LogFlux Collector CLI

The LogFlux Collector CLI is a standalone command-line tool for sending logs to LogFlux servers. It’s perfect for system administrators, DevOps teams, and scenarios where you need to collect logs without modifying application code.

Installation Methods

Download Pre-built Binary

Download the latest release for your platform from the GitHub releases page:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

# macOS (Intel)
curl -L https://github.com/logflux-io/logflux-collector-cli/releases/latest/download/logflux-collector-darwin-amd64 -o logflux-collector
chmod +x logflux-collector

# macOS (Apple Silicon)
curl -L https://github.com/logflux-io/logflux-collector-cli/releases/latest/download/logflux-collector-darwin-arm64 -o logflux-collector
chmod +x logflux-collector

# Linux (x86_64)
curl -L https://github.com/logflux-io/logflux-collector-cli/releases/latest/download/logflux-collector-linux-amd64 -o logflux-collector
chmod +x logflux-collector

# Linux (ARM64)
curl -L https://github.com/logflux-io/logflux-collector-cli/releases/latest/download/logflux-collector-linux-arm64 -o logflux-collector
chmod +x logflux-collector

# Windows
curl -L https://github.com/logflux-io/logflux-collector-cli/releases/latest/download/logflux-collector-windows-amd64.exe -o logflux-collector.exe

Install from Source

If you have Go installed (1.23.0 or later):

1

go install github.com/logflux-io/logflux-collector-cli/cmd/cli@latest

Build from Source

Clone the repository and build:

1
2
3

git clone https://github.com/logflux-io/logflux-collector-cli.git
cd logflux-collector-cli
make build

Initial Configuration

After installation, you’ll need to configure the CLI with your LogFlux credentials. See the Configuration Guide for detailed setup instructions.

Verify Installation

Test the installation and connectivity:

1
2
3
4
5
6
7
8

# Check version
./logflux-collector -version

# Test connectivity
./logflux-collector -health

# Send a test message
./logflux-collector -message "Installation test successful"

System-wide Installation

To install system-wide:

1
2
3
4
5

# Move to system bin directory
sudo mv logflux-collector /usr/local/bin/

# Now you can use it from anywhere
logflux-collector -version

Docker Installation

Run the collector CLI using Docker:

1
2
3
4
5
6
7

# Pull the image
docker pull ghcr.io/logflux-io/logflux-collector-cli:latest

# Run with configuration mounted
docker run -v ~/.logflux-collector.json:/config.json \
  ghcr.io/logflux-io/logflux-collector-cli:latest \
  -config /config.json -message "Docker test"

Next Steps