walk  by antonmedv

Terminal file manager

created 3 years ago
3,447 stars

Top 14.3% on sourcepulse

GitHubView on GitHub
Project Summary

Walk is a terminal file manager designed as a replacement for cd and ls, offering enhanced navigation and file management capabilities for developers and power users. It provides an intuitive, keyboard-driven interface for efficiently browsing and manipulating files directly within the terminal.

How It Works

Walk utilizes a TUI (Text User Interface) approach, rendering file system contents directly in the terminal. Navigation is primarily handled via arrow keys or Vim-like hjkl bindings. Key features include a preview mode for inspecting files without opening them, fuzzy search for quick location of files, and integrated file deletion with an undo function. It also supports custom commands for opening files based on extension and allows configuration of colors and status bar information.

Quick Start & Requirements

  • Install via Homebrew: brew install walk
  • Install via go: go install github.com/antonmedv/walk@latest
  • Install via script: curl https://raw.githubusercontent.com/antonmedv/walk/master/install.sh | sh
  • Pre-built binaries are also available.
  • Optional: Nerd Fonts for icon display.
  • Setup involves adding a helper function to your shell configuration (.bashrc, .zshrc, etc.) to enable lk command for directory changes.

Highlighted Details

  • Vim-like navigation (hjkl) and intuitive keybindings for common operations.
  • Integrated file preview and fuzzy search capabilities.
  • Supports file deletion with an undo feature.
  • Customizable with environment variables for editors, file opening commands, removal commands, and colors.
  • Optional icon display with Nerd Fonts.

Maintenance & Community

The project is maintained by antonmedv. Further community or roadmap information is not detailed in the README.

Licensing & Compatibility

  • License: MIT
  • Compatible with commercial use and closed-source linking due to its permissive MIT license.

Limitations & Caveats

While offering extensive features, the README does not detail specific performance benchmarks or known limitations regarding very large directories or specific operating system compatibility beyond what is implied by the installation methods.

Health Check
Last commit

3 months ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
1
Star History
88 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.