notf0und / zsh-vapor

Laravel vapor plugin for zsh to help you to run vapor from anywhere in the project tree, with auto-completion!

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
• oh-my-zsh
• A Laravel project
• vapor-cli package installed with composer in the project

Installation

Antigen

Add the following bundle to your .zshrc:

antigen bundle notf0und/zsh-vapor

Oh-my-zsh

First download the plugin to your oh-my-zsh custom plugin location:

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:

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:

$ 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 file for details

Acknowledgements

• jessarcher/zsh-artisan this is a copy of that repo with small changes to fit vapor instead of artisan