🥾 walk

<p align="center"> <br> <img src=".github/images/demo.gif" width="600" alt="walk demo"> <br> </p>

Walk — a terminal navigator; a cd and ls replacement.

Run lk, navigate using arrows or hjkl. Press, esc to jump to a new location; or ctrl+c to stay.

Install

brew install walk

pkg_add walk

go install github.com/antonmedv/walk@latest

curl https://raw.githubusercontent.com/antonmedv/walk/master/install.sh | sh

Or download prebuild binaries.

Setup

Put the next function into the .bashrc or a similar config:

<table> <tr> <th> Bash/Zsh </th> <th> Fish </th> <th> PowerShell </th> </tr> <tr> <td>

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

</td> <td>

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

</td> <td>

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

</td> </tr> </table>

Now use lk command to start walking.

Features

Preview mode

Press Space to toggle preview mode.

<img src=".github/images/preview-mode.gif" width="600" alt="Walk Preview Mode">

Delete file or directory

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

<img src=".github/images/rm-demo.gif" width="600" alt="Walk Deletes a File">

Display icons

Install Nerd Fonts and add --icons flag.

<img src=".github/images/demo-icons.gif" width="600" alt="Walk Icons Support">

Image preview

No additional setup is required.

<img src=".github/images/images-mode.gif" width="600" alt="Walk Image Preview">

Usage

| Key binding | Description | |--------------------------------------|--------------------| | <kbd>arrows</kbd>, <kbd>hjkl</kbd> | Move cursor | | <kbd>shift</kbd> + <kbd>arrows</kbd> | Jump to start/end | | <kbd>enter</kbd> | Enter directory | | <kbd>backspace</kbd> | Exit directory | | <kbd>space</kbd> | Toggle preview | | <kbd>esc</kbd>, <kbd>q</kbd> | Exit with cd | | <kbd>ctrl</kbd> + <kbd>c</kbd> | Exit without cd | | <kbd>/</kbd> | Fuzzy search | | <kbd>d</kbd>, <kbd>delete</kbd> | Delete file or dir | | <kbd>y</kbd> | yank current dir | | <kbd>.</kbd> | Hide hidden files |

Configuration

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

export EDITOR=vim

To specify a command to be used to open files per extension, use the WALK_OPEN_WITH environment variable.

export WALK_OPEN_WITH="txt:less -N;go:vim;md:glow -p"

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

Change main color with WALK_MAIN_COLOR environment variable. Available colors are here.

export WALK_MAIN_COLOR="#0000FF"

Use WALK_STATUS_BAR environment variable to specify a status bar program.

export WALK_STATUS_BAR="Size() + ' ' + Mode()"

Flags

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

| Flag | Description | |-----------------|-----------------------------| | --icons | Show icons | | --dir-only | Show dirs only | | --hide-hidden | Hide hidden files | | --preview | Start with preview mode on | | --with-border | Show border in preview mode | | --fuzzy | Start with fuzzy search on |

Related

• fx – terminal JSON viewer
• howto – terminal command LLM helper
• countdown – terminal countdown timer

License

MIT