$
Usage: lrx [command] [options]
A fast, composable command-line toolkit for
developers who prefer the terminal.
Commands:
install Install lrx and its dependencies
docs Browse documentation
about About lrx and its philosophy
config Configure settings
update Check for updates
version Display current version
Options:
-h, --help Show this help message
-v, --verbose Verbose output
-q, --quiet Suppress output
--no-color Disable colored output
# Type a command below to get started.
────────────────────────────────────────────────────────────────────────────────
$
Installing lrx v2.4.1...
+------------------------------------------------+
| Quick Install (recommended) |
+------------------------------------------------+
| |
| curl -sSL https://lrx.sh/install | sh |
| |
+------------------------------------------------+
System Requirements:
OS Linux, macOS, WSL2
Shell bash 4+, zsh 5+, fish 3+
Runtime Node 18+ (optional)
Disk 12MB
Installation Steps:
[########................] 33% Downloading
[################........] 66% Extracting
[########################] 100% Complete
✓ lrx installed successfully to /usr/local/bin/lrx
Alternative Methods:
# Via Homebrew
brew install lrx
# Via npm
npm install -g @lrx/cli
# Build from source
git clone https://github.com/lrx/lrx.git
cd lrx && make install
# Run `lrx --version` to verify installation.
────────────────────────────────────────────────────────────────────────────────
$
LRX Documentation
=====================================
Core Concepts
lrx is built around three principles:
1. Composability
Every command is a Unix-friendly tool.
Pipe, redirect, chain freely.
lrx list | grep "*.md" | lrx process
2. Speed
Written in Rust. Startup time <5ms.
Process 10k files in under a second.
# Benchmark results (M2 MacBook Pro):
lrx scan . 0.003s (10,482 files)
lrx build 0.847s (full project)
lrx deploy 1.204s (to production)
3. Zero Config
Works out of the box. No config files
required. Sensible defaults everywhere.
# Optional: create .lrxrc for overrides
lrx config init
API Reference
=====================================
lrx scan [path] [options]
Scan directory for processable files.
--ext Filter by extension
--depth Max directory depth
--ignore Glob patterns to skip
lrx process [files] [options]
Process files through the lrx pipeline.
--parallel Number of threads
--dry-run Preview without writing
--format Output format (json|csv|text)
lrx deploy [target] [options]
Deploy processed output to target.
--env Environment (dev|staging|prod)
--confirm Skip confirmation prompt
--rollback Rollback to previous deploy
# Full docs: https://lrx.sh/docs
────────────────────────────────────────────────────────────────────────────────
$
About LRX
=====================================
lrx is an open-source command-line toolkit
designed for developers who live in the
terminal.
Version: 2.4.1
License: MIT
Language: Rust
Repository: github.com/lrx/lrx
Downloads: 847,291
+------------------------------------------------+
| Philosophy |
+------------------------------------------------+
| |
| The best tools disappear into your workflow. |
| lrx aims to be the utility you forget is |
| there -- until you need it, and then it just |
| works. |
| |
| We believe in: |
| - Unix philosophy (do one thing well) |
| - Composable interfaces over monoliths |
| - Speed as a feature |
| - Sensible defaults, infinite config |
| - Terminal-first, always |
| |
+------------------------------------------------+
Contributors: 142
Stars: 12.4k
Forks: 891
# Built with care by developers, for developers.
────────────────────────────────────────────────────────────────────────────────
$
Configuration
=====================================
lrx uses a layered config system:
1. Defaults Built-in sensible defaults
2. Global ~/.config/lrx/config.toml
3. Project ./.lrxrc
4. Environment LRX_* env variables
5. CLI flags --flag overrides everything
# Example .lrxrc configuration:
[general]
verbose = false
color = true
threads = 4
[scan]
ignore = ["node_modules", ".git", "dist"]
depth = 10
[deploy]
target = "production"
confirm = true
# Run `lrx config init` to generate a default
# config file for your project.
────────────────────────────────────────────────────────────────────────────────
$
lrx 2.4.1 (2026-03-01)
rustc 1.76.0 (07dca489a 2024-02-04)
platform aarch64-apple-darwin
Changelog (latest):
+ Added lrx deploy --rollback command
+ Added --format csv output option
~ Improved scan performance by 40%
~ Updated dependency resolution
- Fixed crash on symlink loops
- Fixed --quiet flag being ignored
# Run `lrx update` to check for new versions.