README.md

---

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.

Requirements

Bash 3.2 or newer.

Installation

Run install.sh && source ~/.bashrc. For nix, click here.

Tutorial

Click here 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.)

Customization

You can customize the selection keys by editing the config file at ~/.config/shunpo/config:

# Selection keys (exactly 10 characters, one per menu item)
SHUNPO_SELECTION_KEYS="asdfghjkl;"

Rules:

• Must be exactly 10 characters (one for each menu item).
• Cannot contain n, p, or b (reserved for navigation).
• No duplicate characters allowed.
• Invalid configs fall back to the default 0123456789.

Note: CLI arguments (e.g., sg 3, sj 1) always use numeric indices 0-9, regardless of your custom keys.

Uninstalling

Run uninstall.sh