Metadata-Version: 2.1
Name: xontrib-superfile
Version: 0.0.5
Summary: superfile support function for xonsh shell
Keywords: xontrib,xonsh
Author-Email: TechnoStrife <technostrife@gmail.com>
License: MIT
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Topic :: System :: Shells
Classifier: Topic :: System :: System Shells
Classifier: Topic :: Terminals
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Project-URL: Documentation, https://github.com/TechnoStrife/xontrib-superfile/blob/master/README.md
Project-URL: Code, https://github.com/TechnoStrife/xontrib-superfile
Project-URL: Issue tracker, https://github.com/TechnoStrife/xontrib-superfile/issues
Project-URL: repository, https://github.com/TechnoStrife/xontrib-superfile
Requires-Python: >=3.7
Requires-Dist: xonsh>=0.12
Provides-Extra: dev
Description-Content-Type: text/markdown

# Overview
[superfile](https://github.com/yorukot/superfile) support function for xonsh shell


## Installation

To install use pip:
``` bash
xpip install xontrib-superfile
```
``` bash
xpip install -U git+https://github.com/TechnoStrife/xontrib-superfile
```

## Usage
Enable `cd_on_quit` in [superfile config](https://superfile.dev/configure/superfile-config/):
```
cd_on_quit = true
```

This xontrib adds `spf` alias function.
``` bash
$ xontrib load superfile
$ spf
```

Now you can quit superfile normally and xonsh will cd into the last directory.

You can also add your own alias like this: `aliases['s'] = 'spf'`.

`superfile` can also be launched with shortcut `Ctrl+N`. 
This can be changed by setting `$XONSH_SUPERFILE_KEY="c-n"` before loading or disabled with `$XONSH_SUPERFILE_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, not all can be used as a shortcut.)

## Credits

This package was created from [xontrib broot example](https://github.com/jnoortheen/xontrib-broot).
