https://github.com/egurapha/Shunpo

A minimalist bash tool that makes directory navigation just a little bit faster.
https://github.com/egurapha/Shunpo

bash navigation productivity

Last synced: about 1 month ago
JSON representation

A minimalist bash tool that makes directory navigation just a little bit faster.

• Host: GitHub
• URL: https://github.com/egurapha/Shunpo
• Owner: egurapha
• License: mit
• Created: 2024-11-18T01:47:12.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-02-12T03:58:35.000Z (10 months ago)
• Last Synced: 2025-10-13T23:11:40.829Z (about 1 month ago)
• Topics: bash, navigation, productivity
• Language: Shell
• Homepage:
• Size: 2.19 MB
• Stars: 388
• Watchers: 6
• Forks: 10
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-cli-apps-in-a-csv - Shunpo - A minimalist bash tool that makes directory navigation just a little bit faster. (<a name="cd"></a>Directory changers (alternatives to cd))
• awesome-cli-apps - Shunpo - A minimalist bash tool that makes directory navigation just a little bit faster. (<a name="cd"></a>Directory changers (alternatives to cd))

README

          


  

    

    

  

  
Quick navigation with minimal mental overhead.



----

Shunpo is a minimalist bash tool that tries to make directory navigation in terminal just a little bit faster by providing a simple system to manage bookmarks and jump to directories with only a few keystrokes.

If you frequently need to use commands like `cd`, `pushd`, or `popd`, Shunpo is for you.  

![Powered by 🍵](https://img.shields.io/badge/Powered%20by-%F0%9F%8D%B5-blue?style=flat-square)

[![Ko-fi](https://img.shields.io/badge/Ko--fi-Buy%20me%20Tea-ff5f5f?logo=kofi&style=flat-square)](https://ko-fi.com/egurapha)

![Built With Nix](https://img.shields.io/badge/Built%20with-Nix-5277C3?logo=nixos&logoColor=white&style=flat-square)

![Code Formatting](https://img.shields.io/github/actions/workflow/status/egurapha/Shunpo/code_formatting.yml?branch=main&label=Code%20Formatting&style=flat-square)

![Unit Tests](https://img.shields.io/github/actions/workflow/status/egurapha/Shunpo/unit_testing.yml?branch=main&label=Unit%20Tests&style=flat-square)

Requirements

----

Bash 3.2 or newer.

Installation

----

Run `install.sh && source ~/.bashrc`. For nix, click [here](nix/NixREADME.md).

Tutorial

----

Click [here](https://www.youtube.com/watch?v=TN66A3MPo50) for a video tutorial.  



Commands

----

#### Bookmarking:

`sb`: Add the current directory to bookmarks.  

`sg`, `sg [#]` : Go to a bookmark.  

`sr`, `sr [#]` : Remove a bookmark.  

`sl`: List all bookmarks.  

`sc`: Clear all bookmarks.   

#### Navigation:

`sj`, `sj [#]`: "Jump" up to a parent directory.  

`sd`: "Dive" down to a child directory.

#### Selection:

`0~9`: Select an option.  

`n`: Next page.  

`p`: Previous page.  

`b`: Move selection back to parent directory. (For `sd` only.)  

`Enter`: Navigate to selected directory (For `sd` only.)  

 

Uninstalling

----

Run `uninstall.sh`