Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hernancerm/zsh-trampoline
Jump to the places that matter to you
https://github.com/hernancerm/zsh-trampoline
cd navigation zsh zsh-plugin
Last synced: about 1 month ago
JSON representation
Jump to the places that matter to you
- Host: GitHub
- URL: https://github.com/hernancerm/zsh-trampoline
- Owner: hernancerm
- License: mit
- Created: 2023-10-22T03:51:51.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-14T00:23:18.000Z (2 months ago)
- Last Synced: 2024-12-08T22:05:29.624Z (about 2 months ago)
- Topics: cd, navigation, zsh, zsh-plugin
- Language: Shell
- Homepage:
- Size: 103 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
zsh-trampoline
Jump to the places that matter to you.
## What is this?
This is a plugin for Zsh which shares the same purpose as the popular project
[zoxide](https://github.com/ajeetdsouza/zoxide): facilitate `cd`ing to commonly visited
directories. Differently to zoxide, zsh-trampoline is very simple. Instead of using a
ranking algorithm to determine the most likely directory you want to `cd` to,
zsh-trampoline simply displays all your configured dirs and files in fzf, always in the
same order.
## Usage
Press ctrl+j to start fzf with directories and files to "jump" to: `cd` or edit
with `${EDITOR}`. This list is taken from the global parameter `ZT_CONFIG` that you need
to define.
When fzf starts, press asterisk (*) to toggle showing only the dirs and files
explicitly listed in `ZT_CONFIG`. Press enter and now you are on a different
directory or editing a file.
## Installation
- **Step 1.** Install [fzf](https://github.com/junegunn/fzf) version >=0.45 and Git.
[Homebrew](https://brew.sh/) command: `brew install fzf git`
- **Step 2.** Clone the zsh-trampoline Git repository by executing the below command:
```bash
git clone 'https://github.com/hernancerm/zsh-trampoline.git' \
"${HOME}/.zsh-trampoline/zsh-trampoline"
```
- **Step 3.** Place the below snippet at the end of your file `~/.zshrc`:
```bash
# ZSH-TRAMPOLINE - https://github.com/hernancerm/zsh-trampoline
source "${HOME}/.zsh-trampoline/zsh-trampoline/trampoline.plugin.zsh"
ZT_CONFIG=(
# Place each dir and file you want to jump to in a new line.
~ # Example, you can remove this line.
)
zt_setup_widget_jump_to_file
```
- **Step 4.** Start a new shell (restart the terminal or open a new tab).
> [!TIP]
> If you feel comfortable with shell scripting and plan to install other Zsh plugins, like
> [zsh-vi-mode](https://github.com/jeffreytse/zsh-vi-mode) or
> [zsh-syntax-highlighting](https://github.com/zsh-users/zsh-syntax-highlighting) , I
> recommend you use a shell plugin manager like
> [Sheldon](https://github.com/rossmacarthur/sheldon) for the installation. The plugin
> manager would be in charge of doing the git clone (step 2) and sourcing the plugin on
> startup (line beginning with `source` from the snippet of step 3). Using a plugin
> manager can get more complicated than following the steps above, so if you go this way
> then ease of setup should not be your priority.
## Parameter `ZT_CONFIG`
Some things to note:
- If your dir or file has whitespace chars, surround it with single quotes.
- Environment variables, defined as `export MY_VAR=~/file/path`, are supported quoted.
Do not forget to use the `export` keyword. That is, this could be a valid entry in
`ZT_CONFIG`: `'${MY_VAR}'`. The plugin does the expansion.
- On ctrl+j specifically what gets listed is:
- Files. Quoted env vars which point to a file are listed as the env var.
- Level 1 sub-dirs of the dirs in `ZT_CONFIG`. Quoted env vars which point to a dir are
treated as dirs.
- Anything ending in `:0`. In this case the `:0` is stripped. The purpose of this is to
be able to list the dirs themselves which are in `ZT_CONFIG`, avoiding the sub-dirs
replacement.
- While on fzf, on * specifically what gets listed is:
- Allows to toggle between initial listing and items as-are from `ZT_CONFIG`.
## Integration with other Zsh plugins
Integrate with [jeffreytse/zsh-vi-mode](https://github.com/jeffreytse/zsh-vi-mode) (ZVM).
Binding ctrl+j is done inside a ZVM function, as below. Do **NOT** call
`zt_setup_widget_jump_to_file` when integrating with ZVM.
```bash
function zvm_after_init {
zt_zvm_setup_widget_jump_to_file
}
```
## Optional configuration
Optional configuration is provided through parameters.
Zsh parametersAllowed values
Default valueDescription
ZT_KEY_MAP_JUMP
Key map to list dirs & files in fzf. Default: ctrl+j
## Similar projects
-
-
-