Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hadenlabs/zsh-vagrant

Implement for terminal vagrant zsh
https://github.com/hadenlabs/zsh-vagrant

hadenlabs peru plugins vagrant virtualbox zsh

Last synced: 13 days ago
JSON representation

Implement for terminal vagrant zsh

Host: GitHub
URL: https://github.com/hadenlabs/zsh-vagrant
Owner: hadenlabs
License: lgpl-3.0
Created: 2019-10-14T20:05:46.000Z (about 5 years ago)
Default Branch: develop
Last Pushed: 2023-03-05T23:30:28.000Z (almost 2 years ago)
Last Synced: 2024-04-16T01:33:18.783Z (8 months ago)
Topics: hadenlabs, peru, plugins, vagrant, virtualbox, zsh
Language: Makefile
Homepage:
Size: 5.8 MB
Stars: 2
Watchers: 2
Forks: 1
Open Issues: 18
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: docs/code_of_conduct.md

Awesome Lists containing this project

README

# zsh-vagrant

[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/hadenlabs/zsh-vagrant.svg?label=latest&sort=semver)](https://github.com/hadenlabs/zsh-vagrant/releases) [![Lint](https://github.com/hadenlabs/zsh-vagrant/actions/workflows/lint.yml/badge.svg?branch=develop)](https://github.com/hadenlabs/zsh-vagrant/actions) [![Issues](https://img.shields.io/github/issues/hadenlabs/zsh-vagrant.svg)](https://github.com/hadenlabs/zsh-vagrant/issues) [![Latest Release](https://img.shields.io/github/release/hadenlabs/zsh-vagrant.svg)](https://github.com/hadenlabs/zsh-vagrant/releases)

zsh-vagrant plugin for zsh.

## Requirements

This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:

- [zsh-core](https://github.com/hadenlabs/zsh-core)

## Installation

### [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) users

If you're using [oh-my-zsh](https://gitub.com/robbyrussell/oh-my-zsh), install this plugin by doing the following:

1. Go to your oh-my-zsh custom plugins directory -`cd ~/.oh-my-zsh/custom/plugins`
2. Clone the plugin `bash git clone https://github.com/hadenlabs/zsh-vagrant`bash
3. Edit your `.zshrc` and add `plugins=( ... zsh-vagrant )` to your list of plugins
4. Open a new terminal and enjoy!

### [antigen](https://github.com/zsh-users/antigen) users

If you're using [Antigen](https://github.com/zsh-users/antigen), install this plugin by doing the following:

1. Add `antigen bundle hadenlabs/zsh-vagrant` to your `.zshrc` where you're adding your other plugins.
2. Either open a new terminal to force zsh to load the new plugin, or run `antigen bundle hadenlabs/zsh-vagrant` in a running zsh session.
3. Enjoy!

### [antibody](https://github.com/getantibody/antibody) users

If you're using [Antibody](https://github.com/getantibody/antibody), install this plugin by doing the following:

1. Add :

```{.sourceCode .bash}
antibody bundle hadenlabs/zsh-vagrant
```

to your `.zshrc` where you're adding your other plugins.

2. Either open a new terminal to force zsh to load the new plugin, or run `antibody bundle hadenlabs/zsh-vagrant` in a running zsh session.
3. Enjoy!

## Functions

zsh vagrant includes a small utility `vagrant` to fetch and install new packages.

#### `vagrant::install`

Install vagrant.

#### `vagrant::load`

Load path vagrant.

#### `vagrant::upgrade`

Upgrade version vagrant.

#### `vagrant::package::all::install`

Install all package of vagrant.

#### `vagrant::install::versions`

Install versions of config for vagrant.

#### `vagrant::install::version::global`

Install a version global of vagrant.

## Help

**Got a question?**

File a GitHub [issue](https://github.com/hadenlabs/zsh-vagrant/issues).

## Contributing

### Bug Reports & Feature Requests

Please use the [issue tracker](https://github.com/hadenlabs/zsh-vagrant/issues) to report any bugs or file feature requests.

### Development

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

1. **Fork** the repo on GitHub
2. **Clone** the project to your own machine
3. **Commit** changes to your own branch
4. **Push** your work back up to your fork
5. Submit a **Pull Request** so that we can review your changes

**NOTE:** Be sure to rebase the latest changes from "upstream" before making a pull request!

## Module Versioning

This Module follows the principles of [Semantic Versioning (SemVer)](https://semver.org/).

Using the given version number of `MAJOR.MINOR.PATCH`, we apply the following constructs:

1. Use the `MAJOR` version for incompatible changes.
1. Use the `MINOR` version when adding functionality in a backwards compatible manner.
1. Use the `PATCH` version when introducing backwards compatible bug fixes.

### Backwards compatibility in `0.0.z` and `0.y.z` version

- In the context of initial development, backwards compatibility in versions `0.0.z` is **not guaranteed** when `z` is increased. (Initial development)
- In the context of pre-release, backwards compatibility in versions `0.y.z` is **not guaranteed** when `y` is increased. (Pre-release)

## Copyright

## Trademarks

All other trademarks referenced herein are the property of their respective owners.

## License

The code and styles are licensed under the LGPLv3 license [See project license.](LICENSE).

## Don't forget to 🌟 Star 🌟 the repo if you like zsh-vagrant

[Your feedback is appreciated](https://github.com/hadenlabs/zsh-vagrant/issues)