https://github.com/aubreypwd/zsh-plugin-vcshr
A function to help you require vcsh repositories.
https://github.com/aubreypwd/zsh-plugin-vcshr
vcsh vcsh-repositories zsh zsh-plugin zsh-plugins
Last synced: 7 months ago
JSON representation
A function to help you require vcsh repositories.
- Host: GitHub
- URL: https://github.com/aubreypwd/zsh-plugin-vcshr
- Owner: aubreypwd
- License: mit
- Created: 2020-10-02T18:48:49.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-29T15:10:20.000Z (almost 5 years ago)
- Last Synced: 2025-02-16T07:13:30.805Z (9 months ago)
- Topics: vcsh, vcsh-repositories, zsh, zsh-plugin, zsh-plugins
- Language: Shell
- Homepage: https://github.com/RichiH/vcsh
- Size: 3.91 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-zsh-plugins - vcshr - Help vcsh users require GitHub repositories using `vcsh` for auto-installation in `~/.zshrc`, etc. (Plugins / ZSH on Windows)
- fucking-awesome-zsh-plugins - vcshr - Help vcsh users require GitHub repositories using `vcsh` for auto-installation in `~/.zshrc`, etc. (Plugins / ZSH on Windows)
README
# `vcshr`
A function to help `vcsh` users _require_ *Github* repositories using `vcsh` for auto-installation in `~/.zshrc`, etc.
## Usage
```bash
vcshr "" "" "" --overwrite --autoignore --ssh
```
E.g.:
```bash
vcshr "homebrew" "aubreypwd" "vcsh-homebrew" --overwrite --autoignore --ssh
```
Will require `git@github.com:aubreypwd/vcsh-homebrew.git` as `homebrew`.
## Argumentes
- `--overwrite` to make sure that all files get clobbered by the clone process
- `--autoignore` to automatically write a new `.gitignore.d` for the repo
- `--ssh` to use Github's SSH URL vs. HTTPS (default)
## Requires
- `vcsh`*
* If using [homebrew](https://brew.sh) on macOS, these will automatically be installed.
## Install
Using [antigen](https://github.com/zsh-users/antigen):
```bash
antigen bundle aubreypwd/zsh-plugin-vcshr@1.0.0
```
## Development
Install the package on `master`:
```bash
antigen bundle aubreypwd/zsh-plugin-vcshr
```
...and contribute upstream by working in `$HOME/.antigen/bundles/aubreypwd/zsh-plugin-vcshr`.
---
## Changelog
### 1.0.0
- First version