Skip to content

FUSE: Update documentation #15

Description

@efimsky

Parent Issue

Part of #118 (FUSE-based Archive & Remote Browsing Feature)

Summary

Update documentation to reflect new FUSE-based VFS functionality.

Dependencies

Requires #124 (Unmount feature) - all implementation complete

Tasks

CLAUDE.md Updates

  • Update "Out of Scope" section - VFS is no longer out of scope
  • Add new section "Optional System Dependencies" with tool table:
## Optional System Dependencies

Tiny Commander has **zero Python dependencies** but can leverage system tools for extended functionality:

| Tool | Purpose | Install |
|------|---------|---------|
| archivemount | Browse .tar.gz, .tar.bz2, .zip archives | `apt install archivemount` / `brew install archivemount` |
| fuse-archive | Alternative archive browser (more formats) | `apt install fuse-archive` |
| sshfs | Browse SFTP connections | `apt install sshfs` / `brew install sshfs` |
| rclone | Browse FTP, S3, GCS, Azure, Dropbox, etc. | `apt install rclone` / `brew install rclone` |
| p7zip | Browse .7z archives | `apt install p7zip-full` / `brew install p7zip` |
| unrar | Browse .rar archives | `apt install unrar` / `brew install unrar` |

**macOS note:** FUSE tools require [macFUSE](https://osxfuse.github.io/) - approve kernel extension in System Settings > Privacy & Security.

Features are automatically enabled when tools are detected. No configuration required.

README.md Updates

  • Add section about archive browsing feature
  • Add section about remote connection features
  • Include install instructions for optional tools
  • Note macFUSE requirement for macOS

Key Bindings Update

  • Document Enter key behavior on archives
  • Document F9 > Connect menu for remote connections

Files

  • Modify: CLAUDE.md
  • Modify: README.md

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions