Skip to content
Marko Trapani edited this page Mar 24, 2026 · 5 revisions

Welcome to the Redis ACL Builder Wiki

Redis ACL Builder is a high-performance application for testing and validating Redis Access Control List (ACL) rules with real-time command analysis and interactive visual feedback.

license MIT version platform Redis

Note: Available as both a native desktop application and web/Docker deployment. Desktop apps feature auto-updates, offline support, and native performance without requiring Python installation.


πŸš€ Quick Start

New Users

Getting Started

  1. Installation Guide - Choose your platform and get started
  2. Getting Started Tutorial - Learn the basics in 5 minutes
  3. User Guide - Comprehensive feature documentation

πŸ“š Documentation

User Documentation

  • Installation - Platform-specific installation instructions
  • Getting Started - Your first ACL rule in 5 minutes
  • User Guide - Complete feature reference
    • ACL Rule Syntax
    • Interactive Builder
    • Command Testing
    • Keyspace Testing
    • Optimization Engine
  • API Reference - RESTful API documentation for programmatic access

Developer Documentation

Support & Community


✨ Key Features

🎯 Core Capabilities

  • βœ… Parse and validate Redis ACL rule syntax with real-time feedback
  • βœ… Test commands and keyspace patterns with dual testing interface
  • βœ… Visualize granted/blocked commands organized by categories
  • βœ… Support for Redis 7 (379 commands) and Redis 8 (446 commands including modules)
  • βœ… Light/Dark mode theme system with localStorage persistence
  • βœ… Available as web app (Docker/local) and native desktop app (macOS, Windows, Linux)

πŸ–₯️ Desktop Application Features

  • βœ… No Python Required - Standalone bundled application
  • βœ… Auto-Updates - Automatic updates with code signing
  • βœ… Offline Support - Works without internet connection
  • βœ… Native Performance - Fast and responsive UI
  • βœ… Multi-Platform - macOS (Intel + Apple Silicon), Windows, Linux

πŸ”§ Advanced Features

  • βœ… Smart Optimization - Automatic ACL rule simplification
  • βœ… Redundancy Detection - Identifies duplicate/unnecessary terms
  • βœ… Category Completion - Suggests category optimizations
  • βœ… Partial Category Detection - Intelligent mixed permission handling
  • βœ… Resizable Panels - Customizable three-column layout
  • βœ… Drag-and-Drop - Reorder panels and testing sections
  • βœ… Search & Filter - Find commands quickly with fuzzy/exact search

🎯 Latest Release

Current Version: v1.0.0 - First Stable Release

Highlights:

  • πŸŽ‰ First Stable Release - Production-ready with comprehensive test coverage
  • 🏒 Enterprise/OSS Mode Toggle - Switch between Redis deployment types (OSS vs Enterprise command sets)
  • βœ… 100% Test Coverage - 65/65 E2E tests passing
  • πŸ–₯️ Multi-Platform Desktop App - macOS (Intel + Apple Silicon), Windows, Linux with auto-updates
  • 🐳 Docker Multi-Arch - AMD64 and ARM64 images on Docker Hub

View Full Changelog β†’


🀝 Contributing

We welcome contributions! Please see our Contributing Guide for details on:

  • Code of Conduct
  • Development workflow
  • Pull request process
  • Testing requirements
  • Code style guidelines

πŸ“– About This Wiki

This Wiki serves as the primary documentation resource for Redis ACL Builder. It is maintained by the project team and community contributors.

Navigation:

  • Use the sidebar to browse documentation sections
  • Use the search feature (top right) to find specific topics
  • All pages include links to related sections

Contributing to the Wiki:

  • Wiki pages are maintained alongside the codebase
  • Pull requests welcome for improvements and corrections
  • See Contributing Guide for details

πŸ“ License

Redis ACL Builder is open source software licensed under the MIT License.


πŸ”— External Links


Questions? Check the FAQ or start a GitHub Discussion!

Clone this wiki locally