rufio

Runtime Unified Flow I/O Operator

A terminal file manager that keeps your everyday script workflow close at hand. Find files, run Ruby, Python, or PowerShell scripts in the current directory, and check jobs and logs. Add your own actions in Ruby.

日本語 | English

rufio brings finding files, running scripts, and checking results together in one interface.

• Run scripts where your files are: Register your script directories, then press :, type @ + part of a script name, press Tab, and hit Enter. Run Ruby, Python, or PowerShell scripts in the directory you are browsing
• Follow jobs and execution logs: Keep browsing while scripts run in the background. Press J to check jobs and L to view execution logs
• Add your own actions in Ruby: Define custom commands with a small Ruby DSL in ~/.config/rufio/commands.rb. ~/.rufio/commands.rb is also supported
• Use installed tools without extra configuration: Search file names with fzf, search contents with rga, highlight previews with bat, and navigate directory history with zoxide
• Windows support: Run PowerShell scripts with keyboard input handling adapted to Windows terminals
• Trace behavior in the source: The implementation is primarily Ruby, so you can inspect and change the parts you need. Security design is documented in SECURITY.md

• Multi-language Script Support: Ruby, Python, PowerShell
• Script Path Management: Register and manage multiple script directories
• Command Completion: Tab completion for scripts with @ prefix
• Job Management: Run scripts/commands in the background
• Execution Logs: Automatically record all execution results

• Vim-like Key Bindings: Intuitive navigation
• Real-time Preview: Instantly display file contents with syntax highlighting (via bat)
• Fast Search: Integration with fzf/rga
• Bookmarks: Quick access to frequently used directories
• zoxide Integration: Smart directory history

• macOS: Native support
• Linux: Native support
• Windows: PowerShell script support

gem install rufio

Or add to your Gemfile:

gem 'rufio'

rufio           # Launch in current directory
rufio /path/to  # Launch in specified directory

1. Navigate to the directory where you want to place scripts
2. B → 2 to add to script path

1. Press : to enter command mode
2. Type @ + part of the script name
3. Press Tab to complete
4. Press Enter to execute

Press G to search recursively across all bookmarked directories. Tab switches between File names and Content. Type a literal string to search (case insensitive); content results include the file, line number, and matching text. Text is read as UTF-8; files containing NUL bytes in the first 8 KB are skipped as binary. Use Up/Down or Ctrl+N/P to select a result, and press Enter to jump to that file in Files mode. Ctrl+U clears the query; Esc cancels and returns to your previous view. Scanning runs in the background and skips inaccessible directories and directory symlinks. Add bookmarks with b before searching. G mode needs no external search tools. While scanning, a yellow Searching... indicator animates even before matches arrive. It turns green and displays Search complete when the scan finishes.

To exclude extensions from both file name and content searches, add this to ~/.config/rufio/config.rb and restart Rufio:

GLOBAL_SEARCH_EXCLUDED_EXTENSIONS = %w[.png .jpg .zip .tar.gz .log].freeze

Extensions are case insensitive and the leading dot is optional. The default is [] (no extension exclusions). Directory names are unaffected.

Press C to open ~/.config/rufio/, creating it if needed. Navigation, previews, and file operations work as in Files mode. Browse settings and scripts directly; leaving the config directory returns the mode display to Files.

Press : to enter command mode and execute various commands.

:@build           # @ prefix triggers script completion
:@deploy.rb       # Execute registered script
:@local.sh        # Scripts in current directory are also available

:rake:test        # Execute rake task
:rake:build       # Tab completion supported

Rakefile in the current directory is automatically parsed. Supports Rakefile, rakefile, Rakefile.rb.

:!git status      # ! prefix for shell commands
:!ls -la          # Execute in background

:hello            # Greeting message
:stop             # Quit rufio

A feature to register directories containing script files. Scripts in registered directories can be executed using the @ prefix in command mode.

Press B → 3 to open the script path management menu:

• View registered paths
• d: Remove path
• Enter: Jump to directory
• ESC: Close menu

Define custom commands in ~/.config/rufio/commands.rb:

command "hello" do
  ruby { "Hello from rufio!" }
  description "Greeting command"
end

command "status" do
  shell "git status"
  description "Git status"
end

command "build" do
  script "~/.config/rufio/scripts/build.rb"
  description "Run build"
end

~/.config/rufio/
├── config.rb          # DSL-style main configuration
├── script_paths.yml   # Script directories (list format)
├── bookmarks.yml      # Bookmarks (list format)
├── commands.rb        # DSL command definitions
├── scripts/           # Script files
└── logs/              # Execution logs

# ~/.config/rufio/config.rb

# Language setting: 'en' or 'ja'
LANGUAGE = 'ja'

# Color settings (HSL format)
COLORS = {
  directory: { hsl: [220, 80, 60] },
  file: { hsl: [0, 0, 90] },
  executable: { hsl: [120, 70, 50] },
  selected: { hsl: [50, 90, 70] },
  preview: { hsl: [180, 60, 65] }
}.freeze

# Keybind settings
KEYBINDS = {
  quit: %w[q ESC],
  up: %w[k UP],
  down: %w[j DOWN]
}.freeze

# ~/.config/rufio/script_paths.yml
- ~/.config/rufio/scripts
- ~/bin
- ~/scripts

# ~/.config/rufio/bookmarks.yml
- path: ~/Documents
  name: Documents
- path: ~/projects
  name: Projects

Place rufio.yml in your project root for project-specific script paths:

# ./rufio.yml (project root)
script_paths:
  - ./scripts
  - ./bin

rufio integrates with the following external tools to extend functionality. All tools are optional — rufio works without them, falling back to built-in behavior.

When bat is installed, code files in the preview pane are displayed with full syntax highlighting (Ruby, Python, Go, Rust, TypeScript, and 15+ more languages).

Highlighting is loaded asynchronously — navigation stays fast even on large source trees.

# macOS
brew install bat

# Ubuntu/Debian
apt install bat

Run rufio -c to verify bat is detected correctly.

# macOS
brew install fzf bat rga zoxide

# Ubuntu/Debian
apt install fzf bat zoxide
# rga requires separate installation: https://github.com/phiresky/ripgrep-all

Support for native implementation for fast directory scanning:

rufio --native        # Auto-detect
rufio --native=zig    # Zig implementation

rufio --yjit   # Ruby 3.1+ YJIT
rufio --zjit   # Ruby 3.4+ ZJIT

rufio -c              # Check system dependencies
rufio --check-health  # Same as above

• Ruby 2.7.0 or later
• io-console, pastel, tty-cursor, tty-screen gems

git clone https://github.com/masisz/rufio
cd rufio
bundle install
./bin/rufio

bundle exec rake test

MIT License

Bug reports and feature requests are welcome at GitHub Issues. Pull requests are also welcome!