Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/voronkovich/project.plugin.zsh

ZSH plugin for creating projects and navigating between them.
https://github.com/voronkovich/project.plugin.zsh

zsh zsh-plugin

Last synced: about 2 months ago
JSON representation

ZSH plugin for creating projects and navigating between them.

Host: GitHub
URL: https://github.com/voronkovich/project.plugin.zsh
Owner: voronkovich
License: mit
Created: 2015-08-12T14:43:04.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2024-01-19T19:14:38.000Z (about 1 year ago)
Last Synced: 2024-04-17T00:18:49.008Z (9 months ago)
Topics: zsh, zsh-plugin
Language: Shell
Homepage:
Size: 20.5 KB
Stars: 5
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# project.plugin.zsh

[![Tests](https://github.com/voronkovich/project.plugin.zsh/actions/workflows/tests.yaml/badge.svg)](https://github.com/voronkovich/project.plugin.zsh/actions/workflows/tests.yaml)

ZSH plugin for creating projects and navigating between them.

## Installation

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

```sh
antigen bundle voronkovich/project.plugin.zsh
```
### [Zplug](https://github.com/zplug/zplug)

```sh
zplug "voronkovich/project.plugin.zsh"
```

### [Oh My Zsh](https://github.com/ohmyzsh/ohmyzsh)

```sh
git clone https://github.com/voronkovich/project.plugin.zsh ~/.oh-my-zsh/custom/plugins/project
```

Edit `.zshrc` to enable the plugin:

```sh
plugins=(... project)
```

### Manual

Clone this repo and add this into your `.zshrc`:

```sh
source path/to/cloned/repo/project.plugin.zsh
```

## Usage

Plugin supports two types of projects:

- **regular** projects are stored in the directory configured by the `$PROJECTS` environment variable (by default: `~/projects`);
- **temporary** projects are stored in the one of the `/tmp`'s subdirectory (see `$PROJECTS_TMP`).

To create a new regular project or open the existing one, just type a `p` command:

```sh
$ p project-name
```

To create a temporary project use a `-t` option:
```sh
$ p -t project-name
```

Some usefull shortcuts:
```sh
# You can provide an url to the project repo as a second argument. The repo will be cloned automatically
$ p awesome-zsh-plugins https://github.com/unixorn/awesome-zsh-plugins

# Or just type
$ p https://github.com/unixorn/awesome-zsh-plugins
```

### Recipes

Recipe is a piece of code that executes automaically after the project was created. All recipes are located in the directory configured by the `$PROJECTS_RECIPES` environment variable (by default: `~/projects/.recipes`).
Typical recipe could look like this:
```
#!/usr/bin/env zsh
# ~/proects/.recipes/wordpress

wget https://wordpress.org/latest.zip && unzip latest.zip -d . && rm latest.zip
```
In order to run a recipe you should specify it's name by using an `-r` option:
```sh
$ p -tr wordpress wpblog
```
For more examples see [my recipes](https://github.com/voronkovich/dotfiles/tree/master/projects/.recipes).

### Hashes

Plugin defines two usefull hashes: `~p` for a directory with regular projects and `~pt` for a directory with temporary projects. You can use them like this:
```sh
$ cp ~p/project1/README.md ~pt/project2
```

## License