walk

command module
v0.0.0-...-fd805de Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 12, 2024 License: MIT Imports: 33 Imported by: 0

README

🥾 walk

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.

This version is a fork from Anton Medvedev since there are some issues and I thought I could try to maintain it.

Install

go install codeberg.org/TheTuzu/walk@latest

Or download prebuild binaries.

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

Bash/Zsh Fish PowerShell
function lk {
  cd "$(walk "$@")"
}
function lk
  set loc (walk $argv); and cd $loc;
end
function lk() {
  cd $(walk $args)
}

Now use lk command to start walking.

Usage

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

Configuration

You can configure walk trough config file located in ~/.config/walk/config.toml moat of the options are just the flags in a toml file here is an example.

icons = true
preview = false
fuzzy = false
hideHidden = true
dirOnly = false

# Syntax higlighting settings
ColorMode = "terminal8" # Possibe options are: "terminal8", "terminal16",
    # "terminal256" and "terminal16m" which is default
ColorScheme = "monokai" # Here's the complete list https://xyproto.github.io/splash/docs/

# File type
imgViewer = "imv" # default is xdg-open
pdfViewer = "xdg-open" # default is xdg-open
editor = "nvim" # default is nano
rmCmd = "trash" # default is to remove files normally

Do note that the preview flag and setting are bit broken but they still kinda work, pressing space works as expected

Flags can also be used to change the default behaviour 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, disable with //
--hide-hidden don't show hidden files

Changes over the original

Feature Description
--hide-hidden You can not see hidden files by default
changing default app you can change default app for images and PDF files
syntax higlighting You can enable syntax highlighting

There's a bug with the current version where if you do not have theme set to the same theme as your terminal, colours may look broken.

License

MIT

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL