Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jnoortheen/xontrib-broot
broot support function for xonsh shell
https://github.com/jnoortheen/xontrib-broot
broot xonsh xontrib
Last synced: 11 days ago
JSON representation
broot support function for xonsh shell
- Host: GitHub
- URL: https://github.com/jnoortheen/xontrib-broot
- Owner: jnoortheen
- License: mit
- Created: 2020-11-25T14:51:30.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-08T07:31:36.000Z (about 2 years ago)
- Last Synced: 2024-04-27T06:20:08.918Z (7 months ago)
- Topics: broot, xonsh, xontrib
- Language: Python
- Homepage:
- Size: 24.4 KB
- Stars: 9
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-xontribs - broot - supports broot with br alias. (Directory Navigation)
README
# Overview
[broot](https://github.com/Canop/broot) support function for xonsh shell
## Installation
To install use pip:
``` bash
xpip install xontrib-broot
# or: xpip install -U git+https://github.com/jnoortheen/xontrib-broot
```
## Usage
It adds `br` alias function. So commands like `cd` will work from broot.
``` bash
$ xontrib load broot
$ br
```
`broot` can also be launched with shortcut `Ctrl+N`.
This can be changed by `$XONSH_BROOT_KEY="c-n"` or disabled with `$XONSH_BROOT_KEY=""`.
(PS [PTK's keybinding guide](https://python-prompt-toolkit.readthedocs.io/en/master/pages/advanced_topics/key_bindings.html#list-of-special-keys)
for full list of key names.)
## Credits
This package was created with [xontrib cookiecutter template](https://github.com/jnoortheen/xontrib-cookiecutter).