kn /n/
kn is an alternative to cd. It lets you navigate quickly by typing abbreviations. It doesn't track frecency or any other statistics.
NOTE: This project is in an early stage. Issues and PRs are very much welcome.
Enter interactive mode
bash
$ kn
Filter suggestions by typing
Select with Tab and Shift + Tab
You can also use Ctrl + hjkl.
Enter dir with /
Backspace removes the whole input. If the input is empty, it enters the parent dir (unless the search started at current dir).
To change dir, press Enter. Note that kn enters currently selected dir, not the path displayed in gray. This may change in the future.
You can use kn just like cd. The difference is that you can search with abbreviations instead of full dir names. For example, instead of foo/bar you can type fo/ba.
.
├── foo
│ └── bar
├── bar
├── photosxxxxxxxxxxx2021
└── photosxxxxxxxxxxx2020
bash
$ kn foo/bar # Use `kn` just like `cd`...
$ kn fo/br # ...or navigate with abbreviations! No asterisks required.
$ kn pho2021 # Type only the significant parts of the dir name. You can skip the middle part.
You can also use wildcards - to avoid typing a dir name altogether i.e. kn -/beta to go to alpha/beta. Note that kn alph-/bet- will not match alhpa/beta. In this case - functions as a literal character.
bash
$ kn -/bar # Wildcards is used to skip a dir name altogether (changes dir to ./foo/bar/).
If any of ., .., /, ~, - occurs in the argument before normal components, it won't be interpreted as an abbreviation.
So in these examples they work as usual:
``` $ kn . $ kn ./abbr $ kn .. $ kn ../.. $ kn ../../abbr
$ kn / $ kn /abbr
$ kn ~ $ kn ~/abbr
$ kn - ```
In addition, you can use more than two dots in each component of the prefix:
```bash $ kn .. # Go to parent dir (as usual). $ kn ... # Go to grandparent dir (same as ../..). $ kn .... # Go to grand-grandparent dir (same as ../../..).
$ kn ........ # Type as many dots as you want! $ kn .../.... # This works as well.
$ kn .../..../abbr # You can put abbreviations after the prefix. ```
Details about the ordering of found paths
If kn finds many matching paths with the same number of components it orders them in such a way:
Running kn a/-/b on paths below returns them in the following order:
apple/x/b Partial(4) / Wildcard / Complete 1.
= = !=
apple/y/bee Partial(4) / Wildcard / Partial(_) 2.
apple/x/bo Partial(4) / Wildcard / Partial(1) 1.
= = !=
apple/y/bee Partial(4) / Wildcard / Partial(2) 2.
a/x/bo Complete / Wildcard / Partial(1) 1.
!= - -
apple/y/b Partial(4) / Wildcard / Complete 2.
Install kn from crates.io
bash
cargo install kn
OR
Build binary from source
git clone https://github.com/micouy/kn.gitcd knPut the binary in a folder that is in PATH:
cargo build -Z unstable-options --out-dir DIR_IN_PATH --release
Or just build it and copy the binary to that dir:
cargo build --release
cp target/release/_kn DIR_IN_PATH
OR
Download a binary of the latest release for your OS and move it to a directory which is in your $PATH. You may need to change the binary's permissions by running chmod +x _kn.
If there are any problems with the pre-compiled binaries, file an issue.
Then add this line to the config of your shell (notice the underscore in _kn):
fish (usually ~/.config/fish/config.fish):
_kn init fish | source
bash (usually ~/.bashrc):
eval "$(_kn init bash)"
zsh (usually ~/.zshrc):
eval "$(_kn init zsh)"
To be able to use kn, reload your config or launch a new shell instance.
In this project I have entered a lot of areas I have little knowledge about. Contributions and criticism are very welcome. Here are some things you can do:
fish, bash and zsh..., /, . and ~ in the prefix. Expand ~ to $HOME? Difference between $HOME and tilde.--help to kn function.