Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/notf0und/zsh-vapor
Laravel vapor plugin for zsh to help you to run vapor from anywhere in the project tree, with auto-completion!
https://github.com/notf0und/zsh-vapor
Last synced: about 2 months ago
JSON representation
Laravel vapor plugin for zsh to help you to run vapor from anywhere in the project tree, with auto-completion!
- Host: GitHub
- URL: https://github.com/notf0und/zsh-vapor
- Owner: notf0und
- License: mit
- Created: 2020-10-16T14:50:29.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2020-10-16T14:54:31.000Z (over 3 years ago)
- Last Synced: 2024-01-25T15:13:36.049Z (4 months ago)
- Language: Shell
- Size: 3.91 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-zsh-plugins - vapor - Laravel [vapor](https://github.com/laravel/vapor-cli) plugin for ZSH to help you to run `vapor` from anywhere in the project tree, with auto-completion! (Plugins / ZSH on Windows)
- fucking-awesome-zsh-plugins - vapor - Laravel <b><code> 302⭐</code></b> <b><code> 118🍴</code></b> [vapor](https://github.com/laravel/vapor-cli)) plugin for ZSH to help you to run `vapor` from anywhere in the project tree, with auto-completion! (Plugins / ZSH on Windows)
- awesome-zsh-plugins - vapor - Laravel [vapor](https://github.com/laravel/vapor-cli) plugin for ZSH to help you to run `vapor` from anywhere in the project tree, with auto-completion! (Plugins / ZSH on Windows)
README
This plugin adds an `vapor` shell command with the following features:
* It will find and execute `vapor` from anywhere within the project file tree
(and you don't need to prefix it with `php` or `./`)
* It provides auto-completion for `vapor` commands (that also work anywhere
within the project).
## Requirements
* [zsh](https://www.zsh.org/)
* [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh)
* A [Laravel](https://laravel.com/) project
* [vapor-cli](https://github.com/laravel/vapor-cli) package installed with composer in the project
## Installation
### [Antigen](https://github.com/zsh-users/antigen)
Add the following bundle to your `.zshrc`:
```zsh
antigen bundle notf0und/zsh-vapor
```
### Oh-my-zsh
First download the plugin to your oh-my-zsh custom plugin location:
```zsh
git clone https://github.com/notf0und/zsh-vapor.git ~/.oh-my-zsh/custom/plugins/vapor
```
> Note that the repository name is prefixed with `zsh-`, however the plugin
> directory name should just be "vapor".
Then enable the plugin in your `.zshrc` file. For example:
```zsh
plugins=(
vapor
composer
git
)
```
## Usage
Simply use the command `vapor` from anywhere within the directory structure of
a Laravel project and it will search up the tree for the `vapor` command and
execute it. E.g:
```zshrc
$ pwd
~/MyProject/tests/Feature
$ vapor --version
Laravel Vapor 1.9.0
```
Tab-completion will work anywhere that `vapor` can be found, and the available
commands are retrieved on-demand. This means that you will see any vapor
commands that are available to you.
The plugin does not create any aliases for you, but the author would like to
offer some suggestions:
## License
This project is open-sourced software licensed under the MIT License - see the
[LICENSE](LICENSE) file for details
## Acknowledgements
* [jessarcher/zsh-artisan](https://github.com/jessarcher/zsh-artisan)
this is a copy of that repo with small changes to fit vapor instead of artisan