https://github.com/Kaylebor/xonsh_dotfiles
My personal dotfiles, under xonsh shell
https://github.com/Kaylebor/xonsh_dotfiles
asdf configuration dotfiles python xonsh
Last synced: about 1 month ago
JSON representation
My personal dotfiles, under xonsh shell
- Host: GitHub
- URL: https://github.com/Kaylebor/xonsh_dotfiles
- Owner: Kaylebor
- Created: 2020-09-23T16:04:34.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-11-06T12:02:58.000Z (over 4 years ago)
- Last Synced: 2025-03-08T15:08:58.222Z (about 1 month ago)
- Topics: asdf, configuration, dotfiles, python, xonsh
- Language: Shell
- Homepage:
- Size: 22.5 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# My Xonsh dotfiles
## Table of Contents
- [About](#about)
- [Applications included](#apps)
- [Getting Started](#getting_started)
- [Prerequisites](#prerequisites)
Personal dotfiles, using xonsh and asdf.
When setting up this project, multiple additional utilites are also installed:
- [asdf-vm](https://github.com/asdf-vm/asdf), for installing multiple runtimes (set in `.tool-versions` file)
- [exa](https://github.com/ogham/exa), replacing ls with an alias
- [hexyl](https://github.com/sharkdp/hexyl), an hex viewer
- [bat](https://github.com/sharkdp/bat), a similar application to cat but with syntax highlighting (among other functionalities)
- [fd](https://github.com/sharkdp/fd), providing similar functionality to the common find program, while being more efficient
- [ripgrep](https://github.com/BurntSushi/ripgrep), which does the same for grep
- [tldr](https://github.com/tldr-pages/tldr), containing short examples for a lot of tools (for when `man` is too much)
Additionally, [vim-plug](https://github.com/junegunn/vim-plug) is installed in the appropiate folder for [Neovim](https://github.com/neovim/neovim), and my personal [`init.vim`](init.vim) file is likewise linked into place.
[Check the prerequisites](#prerequisites).
Afterwards, clone this repo:
```
git clone https://github.com/Kaylebor/xonsh_dotfiles.git ~/xonsh_dotfiles
cd ~/xonsh_dotfiles
```
You may need to change file permissions:
```
chmod +x setup
```
Finally, run the [setup file](setup).
```
bash setup
```
The first time it may take a while, since some steps involve compiling source code.
`setup` contains some additional, optional arguments; check `./setup --help` for more info
For additional, custom configuration, create a new file called `.localenv` in the `xonsh_dotfiles` folder, with Xonsh syntax.
*OPTIONAL* In order to use xonsh as default shell, `chsh` is not recommended; instead, add something like this to `.bashrc`:
```
XONSH_PATH=$HOME/.local/bin/xonsh # Change if needed
if [[ -t 1 && -x $XONSH_PATH ]]; then
source $HOME/.xonsh_venv/bin/activate # Path where virtualenv was set, if xonsh was installed with pip and venv
exec $XONSH_PATH
fi
```
[Install xonsh](https://xon.sh/installation.html).
**IF INSTALLING XONSH WITH PIP**: Recommended to create a virtual environment with access to global packages first, like `python3 -m venv --system-site-packages .xonsh_venv`
Curl is also needed; if not present, check your distro package repositories.
For erlang, [make sure to install the required dependencies](https://github.com/asdf-vm/asdf-erlang#before-asdf-install)