Skip to main content

Associate files with app or alias and run it without preceding commands in xonsh shell.

Project description

When you click to a file or folder in graphical OS they will be opened in associated app. The xontrib-onepath brings the same logic for the xonsh shell. Type the filename or path without preceding command and an associated action will be executed. The actions are customizable.

If you like the idea of bar theme click ⭐ on the repo and stay tuned by watching releases.

Install

xpip install -U xontrib-onepath
echo 'xontrib load onepath' >> ~/.xonshrc
# Reload xonsh

Default actions

If file has execution permission it will be executed. If typed command is a registered name (i.e. git) and which command returns the path (i.e. /usr/bin/git) it will be executed. In other case the typed path will be used to make action. Default actions:

Type Action
DIR ls
text/ vim
image/ xdg-open

Help to add more types and best default actions. PRs are welcome!

Examples

$ /                      # ls /
$ ~/.xonshrc             # vim ~/.xonshrc
$ ~/Downloads/logo.png   # xdg-open ~/Downloads/logo.png
$ git                    # git
$ ./git                  # ls ./git

Type format

Priority Format Example
1 Full path to file. /etc/passwd
2 File name. file.txt
3 File extension. *.txt
4 MIME type/subtype and extension. text/plain.txt
5 MIME type/subtype. text/plain
6 MIME type. text/
7 Any file. FILE (constant)
8 Any directory. DIR (constant)
9 Any file or directory. * (constant)

To get MIME type for the file run file --mime-type --brief <file>.

Customize actions

Use XONTRIB_ONEPATH_ACTIONS environment variable to add new actions:

$XONTRIB_ONEPATH_ACTIONS['.xonshrc'] = 'vim'         # vim for `.xonshrc` file
$XONTRIB_ONEPATH_ACTIONS['*.log'] = 'tail'           # tail for text type *.log files
$XONTRIB_ONEPATH_ACTIONS['text/plain.txt'] = 'less'  # less for plain text *.txt files 
$XONTRIB_ONEPATH_ACTIONS['DIR'] = 'cd'               # the same as xonsh $AUTO_CD=True
$XONTRIB_ONEPATH_ACTIONS['application/zip'] = 'als'  # list files in zip file using atool

Complex actions

If you need more complex actions use callable xonsh aliases:

import pandas as pd
def _view_csv_with_pandas(args):
    print(pd.read_csv(args[0]))

aliases['view_csv_with_pandas'] = _view_csv_with_pandas
del _view_csv_with_pandas

$XONTRIB_ONEPATH_ACTIONS['application/csv'] = 'view_csv_with_pandas'

Known issues

NTFS in Linux: all files have execute permission

If you mount NTFS partition with default permissions then all files will have execute permission and onepath will execute them instead of action. The right way is to change default /etc/fstab settings. Example:

sudo umount /d
sudo mount -o uid=1000,gid=1000,dmask=027,fmask=137 /d 
ls -la /d

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xontrib-onepath-0.1.6.tar.gz (5.0 kB view hashes)

Uploaded Source

Built Distribution

xontrib_onepath-0.1.6-py3-none-any.whl (4.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page