Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anki-code/xontrib-jump-to-dir
Jump to used before directory by part of the path or command in xonsh shell. Lightweight zero-dependency implementation of autojump or zoxide projects functionality.
https://github.com/anki-code/xontrib-jump-to-dir
autojump cli command-line console shell terminal xonsh xontrib zoxide
Last synced: 13 days ago
JSON representation
Jump to used before directory by part of the path or command in xonsh shell. Lightweight zero-dependency implementation of autojump or zoxide projects functionality.
- Host: GitHub
- URL: https://github.com/anki-code/xontrib-jump-to-dir
- Owner: anki-code
- License: mit
- Created: 2023-01-17T08:13:41.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-15T18:00:24.000Z (6 months ago)
- Last Synced: 2024-10-12T15:56:38.337Z (27 days ago)
- Topics: autojump, cli, command-line, console, shell, terminal, xonsh, xontrib, zoxide
- Language: Python
- Homepage: https://github.com/anki-code/xontrib-jump-to-dir
- Size: 65.4 KB
- Stars: 14
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-xontribs - jump-to-dir - Jump to used before directory by part of the path. Lightweight zero-dependency implementation of autojump or zoxide projects functionality. (Directory Navigation)
README
Jump to used before directory by part of the path in xonsh shell.
Lightweight zero-dependency implementation of autojump or zoxide projects functionality.
If you like the idea click ⭐ on the repo and tweet.
## Note
This xontrib is using [xonsh sqlite history backend](https://xon.sh/tutorial_hist.html#sqlite-history-backend) to get statistics by directories you're used to run commands.
## Installation
To install use pip:
```bash
xpip install xontrib-jump-to-dir
# OR: xpip install -U git+https://github.com/anki-code/xontrib-jump-to-dir
```
## Usage
Init:
```xsh
# Check that you're using sqlite history in ~/.xonshrc
$XONSH_HISTORY_BACKEND = 'sqlite'
xontrib load jump_to_dir
```
Jump to directory by path:
```xsh
mkdir -p /tmp/hello /tmp/world
cd /tmp/hello
echo 1
echo 2
echo 3
cd /tmp/world
echo 1
cd /
j # Jump to most frequent directory i.e. `/tmp/hello/` because 3 `echo` commands were executed.
j wor # Jump to directory with `*wor*` in path i.e. `/tmp/world/`.
j t he # Jump to directory with `*t*he*` in path i.e. `/tmp/hello/`.
```
Jump to directory by command:
```xsh
cd /tmp
echo 112233
cd /
jc 22 # Jump to the directory where `*22*` command executed i.e. `/tmp`.
```
Custom shortcut:
```xsh
$XONTRIB_JUMP_TO_DIR_SHORTCUT = 'z'
xontrib load jump_to_dir
z tm # Jump to previous directory with `*tm*` in path e.g. `/tmp/`
zc git commit #Jump to previous directory where `*git*commit*` command executed e.g. `/git/`
```
## How it works
The history database has the commands you run and the directory where you was. The xontrib sorts the directories from history database by count of executed commands and filter them by mask e.g. the `j tm` command will find the directories by mask `*tm*`. Then you jump into the existing directory with the highest number of executed commands or if you already there to the previous directory by statistics. So if you have no commands that were executed in `/example` directory please avoid expectation that you can jump to it by running `j ex`.
If you want to add fallback functionality to jump to any directory by partial path in case of zero result in history database (e.g. `j o lo bi` will jump to `/opt/local/bin`) feel free to create PR.
## Environment variables
* `XONTRIB_JUMP_TO_DIR_SHORTCUT` - shortcut string. Default `j`.
* `XONTRIB_JUMP_TO_DIR_WARNING` - show warnings from xontrib. Default `True`.
## Credits
This package was created with [xontrib template](https://github.com/xonsh/xontrib-template).