https://github.com/mnixo/nav

A command for simpler terminal navigation.
https://github.com/mnixo/nav

bash command-line command-line-tool easy filter hidden inquirer nav navigation node nodejs search simple terminal yarn

Last synced: about 1 month ago
JSON representation

A command for simpler terminal navigation.

• Host: GitHub
• URL: https://github.com/mnixo/nav
• Owner: mnixo
• License: mit
• Created: 2018-11-01T17:06:20.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-11-03T17:27:13.000Z (over 7 years ago)
• Last Synced: 2025-10-27T02:40:31.328Z (7 months ago)
• Topics: bash, command-line, command-line-tool, easy, filter, hidden, inquirer, nav, navigation, node, nodejs, search, simple, terminal, yarn
• Language: JavaScript
• Homepage:
• Size: 1.02 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# nav

A command for simpler terminal navigation. 

### Features

- Easy to install and use.

- Searchable results.

- Dedicated commands.

### Commands

- `/showFiles` & `/hideFiles`: Whether files (non directories) should be shown in the listing. By default, files are hidden.  

- `/showHidden` & `/hideHidden`: Whether hidden files and directories should be shown in the listing. By default, hidden files and directories are hidden.

### Compatibility

Working on Unix based systems (macOS and linux). Not compatible with Windows.

### Requirements

- `node` to execute the scripts.

- `yarn` to install the dependencies.

### Installing nav 

- `git clone` this repository and `cd` into it.

- Run `yarn` to install its dependencies.

- Run `node alias.js` to get instructions on how to setup the command.

### Using nav

Changing the current working directory:

![nav-01-cwd](./img/nav-01-cwd.gif)

Text search:

![nav-02-search](./img/nav-02-search.gif)

Show files in the listing:

![nav-03-files](./img/nav-03-files.gif)

Show hidden files and directories in the listing:

![nav-04-hidden](./img/nav-04-hidden.gif)