gist-cache-rs Documentation

Welcome to the official documentation for gist-cache-rs, a high-performance CLI tool written in Rust for efficiently caching, searching, and executing GitHub Gists.

What is gist-cache-rs?

gist-cache-rs provides a streamlined workflow for managing and executing your GitHub Gists locally. It features a sophisticated 2-layer caching system that dramatically reduces execution time and network overhead, making it perfect for developers who frequently use Gists as script repositories.

Key Features

• ⚡ High Performance - Lightning-fast caching and search operations implemented in Rust
• 🔄 Smart Updates - Incremental cache updates that only fetch what’s changed
• 💾 2-Layer Caching - Intelligent caching of both metadata and content for 20x faster execution
• 🔍 Flexible Search - Multiple search modes: by ID, filename, or description
• ▶️ Multi-Language Support - Execute scripts in bash, python, ruby, node, php, perl, pwsh, TypeScript and more
• 🎛️ Smart Interpreter Detection - Automatic interpreter selection from shebangs, file extensions, and content analysis (v0.8.6+)
• 💬 Interactive Mode - Full support for interactive scripts
• 📦 Modern Python - uv support with PEP 723 metadata compatibility
• 📥 Easy Downloads - Save Gist files directly to your download folder
• 🗂️ Cache Management - Powerful commands for cache inspection and maintenance
• 📊 Progress Display - Visual feedback with progress bars and spinners
• 🎯 Interactive Selection - Intuitive arrow-key navigation for selecting Gists
• 📋 Output Format Options - JSON output for scripting and automation

Platform Support

gist-cache-rs works seamlessly across Linux, macOS, and Windows 10 or later.

Quick Navigation

For Users

Get started quickly with these essential guides:

• Installation Guide - Set up gist-cache-rs on your system
• Quick Start - Get running in 5 minutes
• Usage Examples - Real-world usage patterns

For Developers

Contributing to the project or want to understand the internals?

• Architecture - Project structure and design patterns
• Testing Guide - Testing strategy and execution
• Coverage Reports - Test coverage analysis
• Test Inventory - Complete test catalog

Test Specifications

Detailed functional verification documentation:

• Test Results Summary
• Caching Tests
• Search Tests
• Interpreter Tests
• Preview Tests

Getting Help

• GitHub Issues: Report bugs or request features
• Documentation: You’re already here!
• Command Help: Run gist-cache-rs --help for CLI reference

License

This project is licensed under the MIT License.