Metadata-Version: 2.1
Name: xontrib-broot
Version: 0.2.1
Summary: broot support function for xonsh shell
Home-page: https://github.com/jnoortheen/xontrib-broot
License: MIT
Keywords: xontrib,xonsh
Author: Noortheen Raja NJ
Author-email: jnoortheen@gmail.com
Requires-Python: >=3.7
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: System :: Shells
Classifier: Topic :: System :: System Shells
Classifier: Topic :: Terminals
Requires-Dist: xonsh (>=0.12)
Project-URL: Code, https://github.com/jnoortheen/xontrib-broot
Project-URL: Documentation, https://github.com/jnoortheen/xontrib-broot/blob/master/README.md
Project-URL: Issue tracker, https://github.com/jnoortheen/xontrib-broot/issues
Project-URL: Repository, https://github.com/jnoortheen/xontrib-broot
Description-Content-Type: text/markdown

# 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).

