Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oh-my-xonsh/oh-my-xonsh
🐍 🐚 🔌 - A delightful framework to give your Python-powered, cross-platform, Unix-gazing Xonsh shell a boost!
https://github.com/oh-my-xonsh/oh-my-xonsh
xonsh xontrib
Last synced: 16 days ago
JSON representation
🐍 🐚 🔌 - A delightful framework to give your Python-powered, cross-platform, Unix-gazing Xonsh shell a boost!
- Host: GitHub
- URL: https://github.com/oh-my-xonsh/oh-my-xonsh
- Owner: oh-my-xonsh
- License: mit
- Created: 2021-09-27T14:17:10.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-01T15:07:34.000Z (8 months ago)
- Last Synced: 2024-07-30T21:06:45.204Z (3 months ago)
- Topics: xonsh, xontrib
- Language: Xonsh
- Homepage:
- Size: 64.5 KB
- Stars: 49
- Watchers: 5
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
- Contributing: contributing.md
- License: license
- Code of conduct: code_of_conduct.md
Awesome Lists containing this project
README
# oh-my-xonsh
# -----------------------------------------------------
# CALL FOR NEW MAINTAINERS
I started this project to bring features of OMZ to the Xonsh community, but no longer use Xonsh, and thus will not be maintaining this project. If you have a proven track record of helpful participation in the Xonsh community and believe this is project you would like to maintain into the future, please open an issue and I can transfer the org.
# -----------------------------------------------------
🐍 🐚 🔌 - A delightful framework to give your Python-powered, cross-platform, Unix-gazing [Xonsh][xonsh] shell a boost!
## Usage
Add the following snippet to your `~/.config/xonsh/rc.xsh` or `~/.xonshrc`:
```shell
# set where oh-my-xonsh lives
if not 'OMX_HOME' in ${...}:
$OMX_HOME = p"~/.config/xonsh/oh-my-xonsh"
# clone omx if needed
if not pf"{$OMX_HOME}".exists():
git clone --depth=1 https://github.com/oh-my-xonsh/oh-my-xonsh $OMX_HOME
# source oh-my-xonsh to give you the `omx` object
source $OMX_HOME/oh-my-xonsh.xsh
# choose your plugins
omx.plugins = [
'autocmd',
'brew',
'clipboard',
'common_aliases',
'copydir',
'dash',
'git',
'gitignore',
'golang',
'iwd',
'macos',
'manpage_coloring',
'shrink_path',
'up',
]
# configure your plugins
# omx.config["plugins.git.skip_aliases"] = True
# initialize oh-my-xonsh
omx.init()
```
## Configuration
Some plugins allow for configuration options. The `omx` object has a `.config` property that allows you to set config values.
You need to be sure you set these values before calling `omx.init()` in your [rc.xsh] file.
For example:
```shell
# set your config options
omx.config["plugins.example.whoami"] = "I'm Batman!"
omx.config["plugins.git.skip_aliases"] = True
# now call init
omx.init()
```
## Adding your own custom plugins
You can add your own custom `.xsh` files or plugins to OMX by using the `$OMX_CUSTOM_HOME` directory.
You can set `$OMX_CUSTOM_HOME` to whatever you want, or you can use the OMX default. An example is
[included][example-plugin] to help you get started.
## The `omx` object
Sourcing Oh-My-Xonsh gives you the `omx` object, which allows you to do lots of great things, such as:
### List available plugins
```shell
$ omx.list_plugins()
--- OMX plugins ---
autocmd
brew
cdls
clipboard
common_aliases
copydir
copyfile
dash
git
gitignore
golang
iwd
jupyter
macos
manpage_coloring
shrink_path
up
--- OMX custom plugins ---
example
```
## Loaded plugins
You can see the `CommandPipeline` details about the plugins you've loaded, including the load times for each plugin.
```shell
$ omx.loaded_plugins
```
### Updating OMX
OMX can update itself if you want as well (which is simply doing a `git pull`).
```shell
$ omx.update()
```
## References
Oh-My-Xonsh is inspired by many wonderful similar projects from other shells:
- [Oh My Zsh][ohmyzsh]
- [Prezto][prezto]
- [Oh My Fish][ohmyfish]
- [Oh My Bash][ohmybash]
[xonsh]: https://xon.sh
[rc.xsh]: https://xon.sh/xonshrc.html
[ohmyzsh]: https://github.com/ohmyzsh/ohmyzsh
[prezto]: https://github.com/sorin-ionescu/prezto
[ohmyfish]: https://github.com/oh-my-fish/oh-my-fish
[ohmybash]: https://github.com/ohmybash/oh-my-bash
[example-plugin]: https://github.com/oh-my-xonsh/oh-my-xonsh/tree/main/custom/plugins/example