How d4rken-org/butler works
Butler is an Android file explorer for power users. A user opens parallel workspace tabs, then browses storage, searches files, edits text, or manages apps; file operations include copy, move, deletion and trash. The shared path/gateway layer represents different storage backends, while ADB and Root/Shizuku provide privileged access. The README documents product capabilities; sampled engine and provider excerpts support selected internal links. Other subsystem wiring is not shown, so those links are omitted.
Main entry points: GatewaySwitch.kt Storage gateways · Workspace.kt Workspace tabs · EditorEngine.kt Text editor · APath.kt Path model
Components 17
Workspace and UI
- Workspace tabs
app-workspace/src/main/java/eu/darken/butler/workspace/core/Workspace.kt - File explorer
app-workspace-explorer/src/main/java/eu/darken/butler/explorer/core/engine/BrowsingEngine.kt
Files and operations
- File operations
app-common-io/src/main/java/eu/darken/butler/common/files/operations/GenericPathMove.kt - Trash bin
app-common-io/src/main/java/eu/darken/butler/common/trash/TrashManager.kt
Storage access
- Path model
app-common-io/src/main/java/eu/darken/butler/common/files/APath.kt - Storage gateways
app-common-io/src/main/java/eu/darken/butler/common/files/GatewaySwitch.kt - Path lookup
app-common-io/src/main/java/eu/darken/butler/common/files/APathLookup.kt - Archive access
app-common-io/src/main/java/eu/darken/butler/common/files/archive/ArchiveGateway.kt - Network storage
app-common-io/src/main/java/eu/darken/butler/common/files/sftp/SftpGateway.kt
Power-user features
- File search
app-workspace-searcher/src/main/java/eu/darken/butler/searcher/core/engine/SearchEngine.kt - Text editor
app-workspace-editor/src/main/java/eu/darken/butler/editor/core/engine/EditorEngine.kt - App manager
app-workspace-apps/src/main/java/eu/darken/butler/apps/core/engine/AppsEngine.kt
Android integration
- Documents provider
app-provider-documents/src/main/java/eu/darken/butler/provider/documents/core/query/DocumentQueryHandler.kt - ADB access
app-common-adb/src/main/java/eu/darken/butler/common/adb/shizuku/AdbServer.kt
Other components
- Android user
- Android storage
- Root / Shizuku
Connections 16
- Android user → Workspace tabs: opens tabs
README.md - Workspace tabs → File explorer: opens browser
README.md - Workspace tabs → File search: opens search
README.md - Workspace tabs → Text editor: opens editor
README.md - Workspace tabs → App manager: opens manager
README.md - File search → Path model: uses paths
app-workspace-searcher/src/main/java/eu/darken/butler/searcher/core/engine/SearchEngine.kt - Text editor → Path model: uses paths
app-workspace-editor/src/main/java/eu/darken/butler/editor/core/engine/EditorEngine.kt - Text editor → Storage gateways: reads and writes
app-workspace-editor/src/main/java/eu/darken/butler/editor/core/engine/EditorEngine.kt - Documents provider → Path lookup: queries paths
app-provider-documents/src/main/java/eu/darken/butler/provider/documents/core/query/DocumentQueryHandler.kt - Documents provider → Storage gateways: queries storage
app-provider-documents/src/main/java/eu/darken/butler/provider/documents/core/query/DocumentQueryHandler.kt - Path model → Storage gateways: routes access
app-common-io/src/main/java/eu/darken/butler/common/files/GatewaySwitch.kt - Storage gateways → Android storage: accesses storage
- Storage gateways → Archive access: supports archives
app-common-io/src/main/java/eu/darken/butler/common/files/GatewaySwitch.kt - Storage gateways → Network storage: supports SFTP
app-common-io/src/main/java/eu/darken/butler/common/files/GatewaySwitch.kt - File operations → Trash bin: deletes to trash
- ADB access → Root / Shizuku: uses privilege