rtfm-filemanager 7.4.0 → 7.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f6bc5298e93ba60c9624f256fb1682476a581e6fdfb80f3995beba600ea20eb
-  data.tar.gz: 36deb1eeacea20c36d354b6c221a41efb7d8f9ee3f093ae8a2905d730e6ad5ca
+  metadata.gz: '018b8cadf670850bb5da46914425bf65bed256bf533619cde79a86981fedd86d'
+  data.tar.gz: 8108aecb15519303db63c76ff43fbf4cf3bedc328ddfb5feaaed9f976cbdb109
 SHA512:
-  metadata.gz: ccf76a6e2c2f7c2f3760a042a1a445619f2fa6688edd0f506b74c215b98feddcd63af8ef98c2f0d9f914af2339d24336b250718af86b205f60e9e2077eedac23
-  data.tar.gz: d350f3eca6a275a5afb052306a3ac15e45f492bda2b47a12b52be9b3b5e11e4ba19b00a73980a5d9be2cd6cff6ad59cd11f624b713fb1d22cb26b3ab24bf6c06
+  metadata.gz: 8b2bf86a29246f99523f33a4d0ce2350acf541eae64dcdfe98be8f0623ec0869b3f534df0e6dda28c9e22f762c395ccfaba5d212ea2abe256b791c1c330422f3
+  data.tar.gz: 149c13f402fd5a757d427cd5c93dc450baaf9a5bf002cc40594a09a48c721ad076b3ffca56308cf0731d35ba713e9c429ed4853e38db1631becf751e3cd56ada

data/CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to RTFM will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [7.4.1] - 2025-11-04
+
+### Fixed
+- **Directory cache invalidation** - Cache now includes file count in addition to mtime
+  - Fixes issue where files created by external processes didn't appear
+  - Cache automatically invalidates when files are added or deleted
+  - More reliable detection of directory changes across filesystems
+
 ## [7.4.0] - 2025-11-03
 
 ### Documentation

data/README.md

@@ -29,6 +29,16 @@ After first run, use `r` command to launch RTFM and exit into your current direc
 
 ---
 
+## Screenshots
+
+| OpenAI File Analysis | Interactive AI Chat |
+|:---:|:---:|
+| ![AI analyzing a PDF](img/screenshot-ai-file.png) | ![AI chat mode](img/screenshot-ai-chat.png) |
+| **Syntax Highlighting** | **System Information** |
+| ![Ruby code highlighting](img/screenshot-syntax.png) | ![System stats (press S)](img/screenshot-system.png) |
+
+---
+
 ## Table of Contents
 
 - [Key Features](#key-features)
@@ -36,6 +46,7 @@ After first run, use `r` command to launch RTFM and exit into your current direc
 - [Keyboard Reference](#keyboard-reference)
 - [Remote SSH/SFTP Browsing](#remote-sshsftp-browsing)
 - [Configuration](#configuration)
+- [OpenAI Integration](#openai-integration)
 - [Plugins](#plugins)
 - [Image Display](#image-display)
 - [RTFM vs Ranger](#rtfm-vs-ranger)
@@ -104,6 +115,17 @@ sudo apt install ruby-full x11-utils xdotool bat pandoc poppler-utils \
 gem install rtfm-filemanager
 ```
 
+#### ArchLinux/derivatives
+```bash
+sudo pacman -Syu ruby bat pandoc poppler odt2txt docx2txt unzip gnumeric catdoc w3m imagemagick ffmpegthumbnailer p7zip libreoffice-fresh
+gem install rtfm-filemanager
+```
+
+Note: catppt is not available in official repos, but RTFM will fall back to using LibreOffice's soffice for .ppt files. For xls2csv, use an AUR helper:
+```
+yay -Syu perl-xls2csv
+```
+
 #### macOS:
 ```bash
 brew install ruby imagemagick w3m bat pandoc poppler
@@ -383,6 +405,73 @@ Configuration stored in `~/.rtfm/conf`
 
 ---
 
+## OpenAI Integration
+
+RTFM includes built-in AI features powered by OpenAI's API for intelligent file analysis and interactive assistance.
+
+### Setup
+
+1. **Get an API key:**
+   - Sign up at https://platform.openai.com/
+   - Generate an API key from your account settings
+
+2. **Configure RTFM:**
+   Add your API key to `~/.rtfm/conf`:
+   ```ruby
+   @ai = "sk-your-actual-api-key-here"
+   @aimodel = "gpt-4o-mini"  # Optional: default model
+   @aicolor = 17             # Optional: chat pane background color
+   ```
+
+The `ruby-openai` gem is already included as a dependency when you install RTFM.
+
+### Features
+
+#### File Description (Press `I`)
+
+Get an intelligent summary of any file or directory:
+- **Files:** Purpose, code review (for source files), library documentation lookup
+- **Directories:** Overview of structure and contents
+- **Git-aware:** Includes recent changes if in a git repository
+- **Smart analysis:** Automatically includes preview content for context
+
+Example uses:
+- Understand unfamiliar codebases quickly
+- Get code review suggestions (bugs, style, improvements)
+- Learn what libraries/APIs are being used
+- See git diff explanations in plain language
+
+#### Interactive Chat (Press `Ctrl-a`)
+
+Start a conversational AI assistant specialized in:
+- File and directory questions
+- Shell command help and suggestions
+- Terminal workflow assistance
+- Programming and scripting guidance
+
+The chat maintains context throughout your RTFM session, so follow-up questions work naturally.
+
+### Configuration Options
+
+```ruby
+# Model selection (in ~/.rtfm/conf)
+@aimodel = "gpt-4o-mini"      # Fast, cost-effective (default)
+@aimodel = "gpt-4o"           # More capable, higher cost
+@aimodel = "gpt-4-turbo"      # Alternative high-end model
+
+# Chat interface color
+@aicolor = 17                 # Dark blue background (default)
+```
+
+### Cost & Privacy
+
+- API calls cost money (typically $0.001-0.01 per request with gpt-4o-mini)
+- File contents are sent to OpenAI when using `I` key
+- No data is sent unless you explicitly press `I` or `Ctrl-a`
+- Chat history persists only during your RTFM session
+
+---
+
 ## Plugins
 
 RTFM supports two types of plugins in `~/.rtfm/plugins/`:

data/bin/rtfm

@@ -18,7 +18,7 @@
 #             get a great understanding of the code itself by simply sending
 #             or pasting this whole file into you favorite AI for coding with
 #             a prompt like this: "Help me understand every part of this code".
-@version    = '7.4.0' # Comprehensive documentation release
+@version    = '7.4.2' # LibreOffice soffice fallback for legacy MS Office formats + ArchLinux support
 
 # SAVE & STORE TERMINAL {{{1
 ORIG_STTY = `stty -g`.chomp
@@ -456,7 +456,7 @@ def display_welcome_message # {{{2
   • docx2txt - Viewing MS Word docx files
   • unzip - Viewing MS PowerPoint pptx files
   • ssconvert (from gnumeric) - Viewing MS Excel xlsx files
-  • catdoc, xls2csv, catppt - Viewing older MS Office formats
+  • catdoc/xls2csv/catppt (with soffice fallback) - Viewing older MS Office formats
   • w3m, ImageMagick - Viewing images
   • ffmpegthumbnailer - Video thumbnails\n".fg(195)
 @firstrun += "
@@ -464,11 +464,15 @@ def display_welcome_message # {{{2
 @firstrun += "
   • Linux (Debian/Ubuntu): Use apt
   • Linux (Fedora/RHEL): Use dnf/yum
+  • Linux (ArchLinux): Use pacman
   • macOS: Use Homebrew (brew)
   • BSD: Use pkg or ports
 
   For Ubuntu/Debian users, install all dependencies with:
   sudo apt install ruby-full git libncurses-dev x11-utils xdotool bat pandoc poppler-utils odt2txt docx2txt unzip gnumeric catdoc w3m imagemagick ffmpegthumbnailer
+  
+  For users of ArchLinux and derivatives, install all dependencies available outside of AUR with:
+  sudo pacman -Syu ruby git ncurses xdotool bat pandoc poppler odt2txt docx2txt unzip gnumeric catdoc w3m imagemagick ffmpegthumbnailer
 
   Note: Package names may vary between platforms. The 'libncurses-dev' package is Linux-specific.".b.fg(87)
 @firstrun += "\n\n
@@ -835,9 +839,9 @@ preview_specs = {
   'docx'               => "docx2txt @s -",
   'xlsx'               => "ssconvert -O 'separator=   ' -T Gnumeric_stf:stf_assistant @s fd://1",
   'pptx'               => "unzip -qc @s | ruby -e '$stdin.each_line{ |i| i.force_encoding(\"ISO-8859-1\").scan(/<a:t>(.+?)<\\/a:t>/).each{ |j| puts j } }'",
-  'doc'                => "catdoc @s 2>/dev/null",
-  'xls'                => "xls2csv @s 2>/dev/null",
-  'ppt'                => "catppt @s 2>/dev/null",
+  'doc'                => "catdoc @s 2>/dev/null || soffice --headless --cat @s 2>/dev/null",
+  'xls'                => "xls2csv @s 2>/dev/null || soffice --headless --cat @s 2>/dev/null",
+  'ppt'                => "catppt @s 2>/dev/null || soffice --headless --cat @s 2>/dev/null",
   # compressed archives
   'zip'                => "unzip -l @s",
   'tar'                => "tar -tvf @s",
@@ -4477,13 +4481,15 @@ def get_cached_dirlist(dir, ls_options, ls_options_with_long = nil) # {{{2
   # Use ls_options_with_long for display, or fall back to ls_options
   ls_options_with_long ||= ls_options
 
-  # Generate cache key with directory mtime for automatic invalidation
+  # Generate cache key with directory mtime AND file count for automatic invalidation
+  # File count catches additions/deletions that may not update mtime immediately
   # Include ls_options_with_long in cache key so toggling @lslong invalidates cache
   begin
     dir_mtime = File.mtime(dir).to_i
-    cache_key = "#{dir}:#{ls_options_with_long}:#{dir_mtime}"
+    file_count = Dir.entries(dir).size
+    cache_key = "#{dir}:#{ls_options_with_long}:#{dir_mtime}:#{file_count}"
   rescue
-    return nil  # Can't cache if we can't get mtime
+    return nil  # Can't cache if we can't get mtime or file count
   end
 
   # Return cached result if available and fresh

data/docs/getting-started.md

@@ -21,6 +21,14 @@ sudo apt install ruby-full x11-utils xdotool bat pandoc poppler-utils \
 gem install rtfm-filemanager
 ```
 
+#### ArchLinux/derivatives
+```bash
+sudo pacman -Syu ruby xdotool bat pandoc poppler odt2txt docx2txt unzip \
+  gnumeric catdoc w3m imagemagick ffmpegthumbnailer tar gzip bzip2 xz unrar p7zip libreoffice-fresh
+
+gem install rtfm-filemanager
+```
+
 ### macOS
 
 ```bash

data/docs/troubleshooting.md

@@ -40,10 +40,13 @@ ruby --version
 # Update Ruby (Ubuntu)
 sudo apt install ruby-full
 
+# Update Ruby (ArchLinux)
+sudo pacman -Syu ruby
+
 # Update Ruby (macOS)
 brew install ruby
 
-# Or use rbenv/rvm for version management
+# Or use rbenv/rvm/asdf for version management
 ```
 
 ## Display Issues

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rtfm-filemanager
 version: !ruby/object:Gem::Version
-  version: 7.4.0
+  version: 7.4.2
 platform: ruby
 authors:
 - Geir Isene
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-04 00:00:00.000000000 Z
+date: 2025-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rcurses
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '7.4'
 description: |-
-  RTFM v7.4.0: Comprehensive documentation release with man page, guides, and examples.
+  RTFM v7.4.2: Added LibreOffice soffice fallback for legacy MS Office formats (.doc/.xls/.ppt) and comprehensive ArchLinux installation support.
    A full featured terminal browser with syntax highlighted files, images shown in the terminal, videos thumbnailed, etc. Features include remote SSH/SFTP browsing, interactive SSH shell, comprehensive undo system, bookmarks, and much more. You can bookmark and jump around easily, delete, rename, copy, symlink and move files. RTFM is one of the most feature-packed terminal file managers.
 email: g@isene.com
 executables: