Getting Started

Goxe transforms noisy log streams into actionable insights. This guide will help you configure your first pipeline to collapse thousands of repetitive entries into smart summaries, cutting storage costs immediately.

How to get started?

Install Goxe

First you need to install Goxe; you can install it from different sources.

If you have Go installed. Recommended Option

Run the following command to download and build the project:
Terminal
```
go install github.com/DumbNoxx/Goxe/cmd/goxe@latest
```
Goxe is a standalone binary with no external dependencies just download and run.
Verify the installation
Terminal
```
goxe -v
# v1.1.2
```
Run Goxe
Terminal
```
goxe
# Server listening on port: 1729
```

In Linux you have different ways to install it.

Download the file corresponding to your PC architecture.

Download .deb (x64)

Download .deb (ARMx64)

The next step would be to double-click or use:

sudo apt install /path/to/Goxe_1.1.2_linux_amd64.deb # Or arm64

Verify the installation
Ubuntu Shell
```
goxe -v
# v1.1.2
```
The latest version should be displayed.
Run goxe
Ubuntu Shell
```
goxe
# Server listening on port: 1729
```

Download the file corresponding to your PC architecture.

Download .rpm (x64)

Download .rpm (ARMx64)

The next step would be to double-click or use:

sudo dnf install /path/to/Goxe_1.1.2_linux_amd64.rpm # Or arm64

Verify the installation
Fedora Shell
```
goxe -v
# v1.1.2
```
The latest version should be displayed.
Run goxe
Fedora Shell
```
goxe
# Server listening on port: 1729
```

In the case of Arch Linux you have two options temporarily

As with Ubuntu, Goxe isn’t in the official repositories, but it is in the AUR.

Choose the helper you use.
Arch Shell
yay -S goxe
Arch Shell
paru -S goxe
Goxe also has its pre-compiled binary in the AUR, so you can install it with paru or yay.
Arch Shell
yay -S goxe-bin
If you use this version, remember to replace goxe with goxe-bin in the following steps. Also, keep in mind that this version is already pre-compiled, so it will skip the build process entirely.
Confirm the installation.
Your AUR helper will automatically download the source code and compile it. Since Goxe has no external dependencies, the process is clean and fast. Simply press Enter when prompted for installation confirmations.
Verify the installation:
Arch Shell
```
goxe -v
# v1.1.2
```
The latest version should be displayed.
Run goxe
Arch Shell
```
goxe
# Server listening on port: 1729
```

The pre-compiled binary is available for direct download in .tar.gz format.

Download .tar.gz (x64)

Download .tar.gz (ARMx64)

Create the destination folder
Terminal
```
mkdir -p /destination/goxe
```
This directory will store the extracted binary. The executable will be exposed globally using a symbolic link.
Extract the archive
Terminal
```
tar -xzvf Goxe_1.1.2_linux_amd64.tar.gz -C /destination/goxe # Or arm64
```
Use the same directory you created in the previous step.
Make the binary executable and create a symbolic link
Terminal
```
chmod +x /destination/goxe/Goxe
sudo ln -s ~/destination/goxe/Goxe /usr/local/bin/goxe
```
Creating the symbolic link requires sudo permissions.
Run Goxe
Terminal
```
goxe
# Server listening on port: 1729
```
The symbolic link allows you to run goxe globally while keeping the binary in its own directory.

In Windows, you can download the pre-compiled binary in .zip format.

Download .zip (x64)

Download .zip (ARMx64)

Extract the downloaded archive to your desired location.
(Optional) Add Goxe to your system PATH for global access:
- Open the Start Menu and search for “Environment Variables”.
- Select “Edit the system environment variables”.
- Click on “Environment Variables”.
- Under “System variables”, find and select the “Path” variable, then click “Edit”.
- Click “New” and add the path to the directory where you extracted Goxe.
- Click “OK” to close all dialog boxes.

Open Command Prompt and verify the installation:
Command Prompt
```
goxe -v
# v1.1.2
```
The latest version should be displayed.
Run Goxe:
Command Prompt
```
goxe
# Server listening on port: 1729
```

If you prefer using PowerShell, follow these steps to run Goxe:

Open PowerShell.
Navigate to the directory where you extracted Goxe:
PowerShell
```
cd "C:\path\to\goxe"
```

Run Goxe:

.\goxe.exe
# Server listening on port: 1729

You can also run Goxe directly from Windows File Explorer.

Open File Explorer.
Navigate to the directory where you extracted Goxe.
Double-click the goxe.exe file.
A terminal window will open and Goxe will start:
```
Server listening on port: 1729
```

The pre-compiled binary is available for direct download in .tar.gz format.

Download .tar.gz (x64)

Download .tar.gz (ARMx64)

Create a directory for the binary
Terminal
```
mkdir -p ~/goxe
```
This directory will store the Goxe binary. A symbolic link will be created for global access.

Extract the archive

tar -xzvf Goxe_1.1.2_macos_amd64.tar.gz -C ~/goxe

Make the binary executable and expose it globally
Terminal
```
chmod +x ~/goxe/Goxe
sudo ln -s ~/goxe/Goxe /usr/local/bin/goxe
```
Creating the symbolic link requires sudo permissions.
If macOS blocks the binary, remove the quarantine flag
Terminal
```
xattr -d com.apple.quarantine ~/goxe/Goxe
```
This is required for unsigned binaries downloaded from the internet.
Run Goxe
Terminal
```
goxe
# Server listening on port: 1729
```

You already have Goxe on your system; any bug reports or suggestions for improvement can be submitted through.

Issues Repository