Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zshzoo/magic-enter
Make your enter key magical by binding a Zsh command to it
https://github.com/zshzoo/magic-enter
zsh zsh-plugin
Last synced: about 1 month ago
JSON representation
Make your enter key magical by binding a Zsh command to it
- Host: GitHub
- URL: https://github.com/zshzoo/magic-enter
- Owner: zshzoo
- License: mit
- Created: 2021-12-13T03:09:51.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-21T15:26:09.000Z (11 months ago)
- Last Synced: 2024-01-23T22:05:12.735Z (4 months ago)
- Topics: zsh, zsh-plugin
- Language: Shell
- Homepage:
- Size: 9.77 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-zsh-plugins - magic-enter - Make your enter key magical by binding a ZSH command to it. (Plugins / ZSH on Windows)
- fucking-awesome-zsh-plugins - magic-enter - Make your enter key magical by binding a ZSH command to it. (Plugins / ZSH on Windows)
- awesome-zsh-plugins - magic-enter - Make your enter key magical by binding a ZSH command to it. (Plugins / ZSH on Windows)
README
# magic-enter
[](/LICENSE)
[][zshzoo]
[](#install-for-prezto)
> Make your enter key magical by binding a Zsh command to it
## Description
Based on [magic-enter](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/magic-enter).
## Customization
You can define your own `magic-enter` commands using the following zstyles.
```zsh
zstyle -s ':zshzoo:magic-enter' command 'ls -laFh .'
zstyle -s ':zshzoo:magic-enter' git-command 'git status -sb .'
```
You can also define your own `magic-enter-cmd` function. Whatever it prints is what will be run when no other command is given. You can use this if you want to extend the command beyond just looking for a git repo.
```zsh
function magic-enter-cmd {
if [[ -n "$$VIRTUAL_ENV" ]]; then
echo "python3 --version"
else
echo "ls -laFh ."
fi
}
```
## Installation
### Install with a Zsh plugin manager
To install using a Zsh plugin manager, add the following to your .zshrc
- [antidote]: `antidote bundle zshzoo/magic-enter`
- [zcomet]: `zcomet load zshzoo/magic-enter`
- [zgenom]: `zgenom load zshzoo/magic-enter`
- [znap]: `znap source zshzoo/magic-enter`
### Install manually, without a plugin manager
To install manually, first clone the repo:
```zsh
git clone https://github.com/zshzoo/magic-enter ${ZDOTDIR:-~}/.zplugins/magic-enter
```
Then, in your .zshrc, add the following line:
```zsh
source ${ZDOTDIR:-~}/.zplugins/magic-enter/magic-enter.zsh
```
### Prezto Install
To install with [Prezto][prezto], first clone the repo from an interactive Zsh session:
```zsh
# make sure your $ZPREZTODIR is set
ZPREZTODIR=${ZPREZTODIR:-~/.zprezto}
# clone the repo to a prezto contrib dir
git clone https://github.com/zshzoo/magic-enter $ZPREZTODIR/contrib/magic-enter/external
# set up the contrib
echo "source \${0:A:h}/external/magic-enter.plugin.zsh" > $ZPREZTODIR/contrib/magic-enter/init.zsh
```
Then, add the plugin to your Prezto plugins list in .zpreztorc
```zsh
zstyle ':prezto:load' pmodule \
... \
magic-enter \
...
```
[ohmyzsh]: https://github.com/ohmyzsh/ohmyzsh
[prezto]: https://github.com/sorin-ionescu/prezto
[zshzoo]: https://github.com/zshzoo/zshzoo
[antidote]: https://github.com/mattmc3/antidote
[zcomet]: https://github.com/agkozak/zcomet
[zgenom]: https://github.com/jandamm/zgenom
[znap]: https://github.com/marlonrichert/zsh-snap