Installation
loq can be installed on Windows, macOS, and Linux using several methods.
Pre-built Binaries
Download pre-built binaries from the GitHub Releases page.
macOS
# Download and extract
curl -LO https://github.com/chaynes81-ux/loq/releases/latest/download/loq-darwin-arm64.tar.gz
tar xzf loq-darwin-arm64.tar.gz
# Move to PATH
sudo mv loq /usr/local/bin/
# Verify installation
loq --versionFor Intel Macs, use loq-darwin-x86_64.tar.gz instead.
Linux
# Download and extract
curl -LO https://github.com/chaynes81-ux/loq/releases/latest/download/loq-linux-x86_64.tar.gz
tar xzf loq-linux-x86_64.tar.gz
# Move to PATH
sudo mv loq /usr/local/bin/
# Verify installation
loq --versionWindows
# Download from GitHub releases
Invoke-WebRequest -Uri https://github.com/chaynes81-ux/loq/releases/latest/download/loq-windows-x86_64.zip -OutFile loq.zip
# Extract
Expand-Archive loq.zip -DestinationPath C:\loq
# Add to PATH (run as Administrator)
$env:Path += ";C:\loq"
[Environment]::SetEnvironmentVariable("Path", $env:Path, [EnvironmentVariableTarget]::Machine)
# Verify installation
loq --versionBuild from Source
Building from source requires Rust 1.70 or later.
Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source $HOME/.cargo/envBuild loq
# Clone the repository
git clone https://github.com/chaynes81-ux/loq.git
cd loq
# Build release version
cargo build --release
# The binary is at target/release/loq
./target/release/loq --versionInstall with Cargo
# Install directly from crates.io (when published)
cargo install loq
# Or install from the repository
cargo install --git https://github.com/chaynes81-ux/loq.gitDocker
loq is available as a Docker image for containerized environments.
Pull the Image
docker pull loq/loq:latestRun a Query
# Mount your data directory
docker run --rm -v $(pwd)/data:/data loq/loq:latest \
"SELECT * FROM /data/sample.csv"Using Docker Compose
Create a docker-compose.yml:
version: '3.8'
services:
loq:
image: loq/loq:latest
volumes:
- ./data:/data:ro
command: ["SELECT * FROM /data/logs.csv"]Run with:
docker-compose run --rm loqREST API Server
loq includes a REST API server for programmatic access.
Docker
# Run the server
docker run -d -p 8080:8080 -v $(pwd)/data:/data loq/loq-server:latest
# Test the endpoint
curl http://localhost:8080/api/v1/healthFrom Source
# Build and run the server
cargo run -p loq-server
# The server listens on http://0.0.0.0:8080See the REST API documentation for details.
Kubernetes
For Kubernetes deployment, see the Kubernetes guide.
Verify Installation
After installation, verify loq is working:
# Check version
loq --version
# Run a simple query
echo "name,age\nAlice,30\nBob,25" > test.csv
loq "SELECT * FROM test.csv"Expected output:
name,age
Alice,30
Bob,25Platform-Specific Notes
macOS
On macOS, you may need to allow the binary to run:
# If you see "cannot be opened because the developer cannot be verified"
xattr -d com.apple.quarantine /usr/local/bin/loqWindows
Some input formats (ETW, ADS) are Windows-only. On other platforms, these formats will return a clear error message.
Linux
For EVTX parsing on Linux, no additional dependencies are required - the cross-platform EVTX parser is included.
Troubleshooting
Command not found
Ensure the binary is in your PATH:
# Check if loq is in PATH
which loq
# If not, add to PATH (Linux/macOS)
export PATH="$PATH:/path/to/loq"Permission denied
Make the binary executable:
chmod +x /path/to/loqBuild errors
Ensure you have the latest Rust toolchain:
rustup update stableStaying Updated
Get notified when new versions of loq are released.
GitHub Watch (Recommended)
The easiest way to get notified of new releases:
- Go to the loq GitHub repository
- Click the Watch button (top right)
- Select Custom → check Releases → click Apply
You'll receive an email whenever a new version is released.
RSS Feed
Subscribe to releases via RSS/Atom feed:
https://github.com/chaynes81-ux/loq/releases.atomAdd this URL to your favorite RSS reader (Feedly, Inoreader, etc.) to see new releases in your feed.
Check Your Version
To see which version you have installed:
loq --versionCompare with the latest release to see if you're up to date.
Updating
How to update depends on your installation method:
brew upgrade loqcargo install loq --forcedocker pull loq/loq:latest# Download the latest release and replace the binary
curl -LO https://github.com/chaynes81-ux/loq/releases/latest/download/loq-darwin-arm64.tar.gz
tar xzf loq-darwin-arm64.tar.gz
sudo mv loq /usr/local/bin/Next Steps
- Quick Start - Learn the basics with hands-on examples
- CLI Reference - Full command-line options
- Input Formats - Supported input formats