/Terminal-File-Explorer-Golang

🔍 A terminal file browser with Vim-style navigation and preview panel. Built in Go, featuring a TUI interface, Docker support, and cross-platform compatibility. Navigate directories like a Vim pro! 🚀

Primary LanguageGo

Terminal File Explorer

Go TUI Docker Make Homebrew Community License

TUI Screenshot
A Vim-inspired terminal file manager with modern UX/UI components

GitHub stars GitHub release

✨ Key Features

Navigation & Interface

🖥️ Dual-Pane Layout

  • Left panel: Hierarchical directory navigation
  • Right panel: File previews (text/images) & metadata

🎮 Vim-Style Controls

  • Muscle-memory friendly keybindings (hjkl navigation)
  • Mode switching (normal/visual/command)

Deployment Options

🐋 Containerized

  • Pre-built Docker images with Alpine base
  • Volume mounting support

🍺 Homebrew Ready

  • Single-command installation for macOS/Linux
  • Automatic updates via brew

🚀 Quick Start

Installation

# Via Docker
docker run -it --rm -v $PWD:/data ghcr.io/devalentineomonya/terminal-file-explorer:latest

# Homebrew 
brew tap devalentineomonya/tools
brew install terminal-file-explorer

# From Source
git clone https://github.com/devalentineomonya/Terminal-File-Explorer-Golang.git
cd Terminal-File-Explorer-Golang
make build && make install

Make Commands

build    # Compile binary
install  # Install system-wide
docker   # Build Docker image
clean    # Remove build artifacts
run      # Start in dev mode

🐋 Docker Compose

version: '3.8'
services:
  file-explorer:
    image: ghcr.io/devalentineomonya/terminal-file-explorer:latest
    volumes:
      - ./:/workspace
    environment:
      - TUI_THEME=dark
    devices:
      - /dev/fuse:/dev/fuse

🛠 Development

# Build with Make
make build

# Run tests
make test

# Create release builds
make release

# Build Docker image
make docker

🌐 Community

GitHub Discussions Twitter Follow

🛣 Roadmap

GitHub Milestones

📜 License

MIT License - See LICENSE


Maintainer: Valentine Omonya
Contribute: Guidelines
Support: Open an Issue