Skip to content

anki-code/xontrib-rc-awesome

Folders and files

NameName
Last commit message
Last commit date

Latest commit

f47ef91 Β· Jan 9, 2025
Jan 6, 2023
Jan 9, 2025
Oct 2, 2020
Jul 16, 2024
Aug 8, 2022
Jun 24, 2024

Repository files navigation

Awesome snippets of code for xonshrc in xonsh shell.

If you like the idea click ⭐ on the repo and tweet.

First of all

Learn about xonsh run control (RC) files in official docs - Run Control File. You should know about what RC files are used in interactive and non-interactive sessions.

Use cases

Create your own pip-installable RC based on the awesome xonsh RC

  1. Fork this repository

  2. Rename the repository to xontrib-rc-yourname

  3. Change the name in setup.py

  4. Change the name of xontrib/rc_awesome.xsh to xontrib/rc_yourname.xsh

  5. Add xontribs you need to setup.py (the xontribs will be installed automatically during pip install)

  6. Now you can just run anywhere:

    pip install -U git+https://github.com/yourname/xontrib-rc-yourname
    
    # Only for interactive mode:
    # (You can also create autoloadable xontrib using xontrib-template.)
    echo 'xontrib load rc_yourname' >> ~/.xonshrc
    
    # For interactive or non-interactive (https://xon.sh/xonshrc.html):
    # mkdir -p ~/.config/xonsh/rc.d/
    # echo 'xontrib load rc_yourname' > ~/.config/xonsh/rc.d/rc_yourname.xsh
    
    xonsh

    Also you can avoid manual loading the xontrib in ~/.xonshrc by creating autoloadable xontrib using xontrib-template. Answer yes on the question about enabling autoloading.

  7. Increment version to update the package using pip install -U git+https://github.com/yourname/xontrib-rc-yourname

  8. Take a look into xonsh-awesome-cli-app if you want to create your own toolset.

Copy and paste

Just read rc_awesome and copy the snippets to your xonsh RC.

Or add awesome xonsh RC to the end of your xonshrc:

curl -s https://raw.githubusercontent.com/anki-code/xontrib-rc-awesome/main/xontrib/rc_awesome.xsh >> ~/.xonshrc

Or install awesome xonsh RC as a package with automatically installable xontribs:

pip install -U git+https://github.com/anki-code/xontrib-rc-awesome
echo 'xontrib load rc_awesome' >> ~/.xonshrc
xonsh

Learn from xonsh RC gurus

See also

  • xonsh-cheatsheet - cheat sheet for xonsh shell with copy-pastable examples.
  • xontrib-template - Full-featured template for building extension (xontrib) for the xonsh shell.