Navi (interactive cli cheatsheet) integration
Project description
navi (interactive cli cheatsheet) integration into xonsh (shell)
If you like the idea click ⭐ on the repo
Install
xpip install xontrib-navi
# or: xpip install -U git+https://github.com/eugenesvk/xontrib-navi
Configure
- Add the following to your
.py
xontrib loading config andimport
it in your xonsh run control file (~/.xonshrc
or~/.config/rc.xsh
):
from xonsh.xontribs import xontribs_load
from xonsh.built_ins import XSH
envx = XSH.env
xontribs = [ "navi", # Initializes navi (interactive cli cheatsheet)
# your other xontribs
] # ↓ optional configuration variables (use `False` to disable a keybind)
if 'navi' in xontribs: # Configure navi only if you're actually loading it
# config var value |default|alt_cmd¦ comment
envx["X_NAVI_KEY"] = "⎈g" #|c-g| False¦ Autofill existing command with navi's best match or launch navi if no good match found
# run to see the allowed list for ↑: from prompt_toolkit.keys import ALL_KEYS; print(ALL_KEYS)
# Alt is also supported as either of: a- ⎇ ⌥ (converted to a prefix 'escape')
# Control symbols are also supported as either of: ⎈ ⌃
xontribs_load(xontribs) # actually load all xontribs in the list
- Or just add this to your xonsh run control file
xontrib load navi # Initializes navi (interactive cli cheatsheet)
# configure like in the example above, but replace envx['VAR'] with $VAR
$X_NAVI_KEY = "c-g" # ...
Use
- ⎈g run navi
git sta
⎈ggit status
autoreplace with navi's best matchgit status
⎈g run navi with current command as search inputgit sta‸; git show
⎈ggit status‸; git show
autoreplace only the command at ‸cursor
Known issues
- Bottom toolbar may temporary disappear on some invokations of the commands in this xonrib likely due to this xonsh issue
Credits
This package was created with xontrib template
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_navi-0.0.5.tar.gz
(4.8 kB
view hashes)
Built Distribution
Close
Hashes for xontrib_navi-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb392e4a44febcd49cfadccfb8045f3b652e9c1718abce2285063ca15d9df14d |
|
MD5 | 95cf04f0dec2b8d172d118749cf95fe9 |
|
BLAKE2b-256 | ab1b82518ee3e28a43014d377dbdd69f838b2a9e8e67dfdd2a9bd4db8b00735f |