walk 🥾

This fork:

• Differences with upstream are signposted with a ⚠️
• Feature parity is a non-goal

---

Walk — a terminal navigator.

Why another terminal navigator? I wanted something simple and minimalistic. Something to help me with faster navigation in the filesystem; a cd and ls replacement. So I build walk. It allows for quick navigation with fuzzy searching, cd integration is quite simple. And you can open vim right from the walk. That's it.

Install ⚠️

Use go build for now.

Then put this function into the .bashrc or a similar config:

Bash:

function lk {
  cd "$(walk "$@")"
}

Fish:

function lk
  set loc (walk $argv); and cd $loc;
end

Powershell:

function lk() {
  cd $(walk $args)
}

Now use lk command to start walking.

Preview mode

Press , to toggle preview mode.

Delete file or directory

Press delete to delete file or directory. Press u to undo.

Display icons

Install Nerd Fonts and add --icons flag.

Image preview

No additional setup is required.

Usage ⚠️

 Key binding       Description
--------------------------------------
arrows, wasd, hjkl  Move cursor
shift+up, W, g      Move to top of column
shift+dn, S, G      Move to bottom of column
shift+lt, A, H      Move to left-most column
shift+rt, D, L      Move to right-most column
Home                Move to beginning
End                 Move to end
enter, space        Enter directory/Open file
enter, space        Enter directory/Open file
e                   Edit file
backspace           Exit directory
esc, q              Exit with cd
ctrl+c              Exit without cd
,                   Toggle preview
.                   Hide hidden files
/, f                Fuzzy search
delete              Delete file or dir
y                   Yank current dir

Note: Files should open in their default programs using:

• Invoke-Item on Windows
• xdg-open on Linux
• open on Mac (untested)
• This is experimental.

Configuration ⚠️

The EDITOR or WALK_EDITOR environment variable used for opening files from the walk.

export EDITOR=vim

The WALK_REMOVE_CMD environment variable can be used to specify a command to be used to remove files. This is useful if you want to use a different command to remove files than the default rm.

export WALK_REMOVE_CMD=trash

Flags can be used to change the default behavior of the program.

 Flag          Description
------------------------------------------
 --icons     Show icons
 --dir-only  Show dirs only
 --preview   Start with preview mode on
 --fuzzy     Start with fuzzy search on

License

MIT