Quick navigation with minimal mental overhead.

---

Shunpo is a minimalist shell 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.

New: Now fully compatible with both Bash and Zsh! 🚀

Requirements

• Bash 3.2 or newer, or
• Zsh 5.0 or newer

Note: Zsh compatibility was added using Claude Code to ensure seamless functionality across both shells.

Installation

The installation script automatically detects your shell and configures the appropriate RC file:

./install.sh

Then reload your shell configuration:

• Bash: source ~/.bashrc
• Zsh: source ~/.zshrc

For nix installation, 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.)

Uninstalling

Run uninstall.sh

Testing

Shunpo includes comprehensive tests that work with both Bash and Zsh:

# Run tests with automatic shell detection
./run_tests.sh

# Or run tests manually with BATS
bats tests/test_bookmarks.bats tests/test_navigation.bats

Requirements: BATS (Bash Automated Testing System)

• Ubuntu/Debian: sudo apt-get install bats
• macOS: brew install bats-core
• Manual: github.com/bats-core/bats-core

Credits

Based on the original Shunpo project by Raphael Eguchi. Zsh compatibility and additional improvements added using Claude Code.