A small script which can be found at examples/emojis.sh to copy an emoji to the clipboard. To use it follow the installation instructions at the bottom and manually install emojify.

Navigator allows you to navigate through heavy output with ease. You can feed it a string and it gives you in return a beautiful interface from where you can select or search.

It differentiates itself by providing support for folders. Simply because folders allow for much cleaner and simpler navigation.

Btw. it's a very immature project.
So don't expect any ✨ bling ✨ (for now).

But if you want to know what could come, you can have a look at the todo list.

• Installation
• Usage
• Shortcuts
• Configuration
• Dependencies

Simpy clone and install the package locally with cargo. Cargo probably installs the binary to the default locations ~/.cargo/bin. Make sure to put that in your path so you can call it.

git clone https://github.com/OrangeFran/navigator.git
cargo install --path navigator

The application uses a lot of emojis, because I like them. You can use the lame mode if you hate emojis. But if you do want to use them, install the noto-fonts-emoji package.

First of all, while doing this project I've had some trouble with unix-streams. Especially when I wanted to allow piping the output to another command. I solved this by using sdtout for the terminal user interface and stderr to output the selected item. If you want to use this in a chain of commands, you have to redirect stderr to stdout and stdout to stderr: navigator 3>&2 2>&1 1>&3 3>&-.

To simplify this I created a script called wrapper.sh that enables you to use it like any other command in a chain: echo "test" | ./wrapper.sh --lame | less.

I suggest to put that file somewhere in your path and call it navi.

sudo cp wrapper.sh /usr/local/bin/navi

Now it's as simple as using navi instead of navigator.

If you use the fish shell, you can also use 2> | to pipe the output.

echo "test" | navigator 2> | less

Look at some examples in the examples/ folder to learn more and get some ideas of possible usages.

There are some flags you can use. Access the help menu with --help. It's pretty basic for now. You can pass in a string to process or read from standard input.

After the string is read, it get's parsed into a list of folders and files. By default it seperatres folders and subfolders with a tab.

file
folder
    file
    folder
        file
file

You can even use nested folder. If there are errors, please open an issue.

You can specify a custom seperator with -s or --sep. By default it's a tab (\t) as mentioned above.

This tool is mostly built for people who want to script stuff. But you can sure use it for everything you want to. If you'd like to share a cool script, you can make a pull request.

Navigator is a terminal-user-interface, so it relies on shortcuts. But it's a simple tool, so there is no need to panic. If you know vim, you're probably good to go.

Here's a list:

• h
  • go back one folder (if possible)
• l
  • enter a folder (if possible)
• j
  • scroll down
• k
  • scroll up
• p
  • toggle display modes (structured / full path)
• g
  • go to the top
• G
  • go to the bottom
• q
  • quit
• /
  • search for something with regular expressions
• esc
  • switch back to the list
• enter
  • return the selected element

Personally I really like customisation, but I don't think it makes a lot of sense focusing on it in such a young project. Fortunately you can at least change the colors.

There is a default config file in at config/config.toml. It is filled with the default options. Please excuse the fact that you have to include at least this

selector = "> "
lame = false

[theme.selected]
[theme.default]

in your config file to work. I'm working on making everything optional. But I don't really like my implementation. I'd be happy to take suggestions.

You can see every avaible option here.

tui-rs
termion

clap

toml
serde