Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Cloudstek/zsh-plugin-appup
The command that can save you typing 15 characters or more, each time!
https://github.com/Cloudstek/zsh-plugin-appup
aliases docker docker-compose oh-my-zsh oh-my-zsh-plugin vagrant zsh
Last synced: about 1 month ago
JSON representation
The command that can save you typing 15 characters or more, each time!
- Host: GitHub
- URL: https://github.com/Cloudstek/zsh-plugin-appup
- Owner: Cloudstek
- License: mit
- Created: 2018-03-08T11:18:21.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-06-06T09:44:18.000Z (12 months ago)
- Last Synced: 2024-03-26T22:24:05.583Z (about 2 months ago)
- Topics: aliases, docker, docker-compose, oh-my-zsh, oh-my-zsh-plugin, vagrant, zsh
- Language: Shell
- Homepage:
- Size: 29.3 KB
- Stars: 18
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-zsh-plugins - appup - Adds `start`, `stop`, `up` and `down` commands when it detects a `docker-compose.yml` or `Vagrantfile` in the current directory (e.g. your application). Just run `up` and get coding! (Plugins / ZSH on Windows)
- fucking-awesome-zsh-plugins - appup - Adds `start`, `stop`, `up` and `down` commands when it detects a `docker-compose.yml` or `Vagrantfile` in the current directory (e.g. your application). Just run `up` and get coding! (Plugins / ZSH on Windows)
- awesome-zsh-plugins - appup - Adds `start`, `stop`, `up` and `down` commands when it detects a `docker-compose.yml` or `Vagrantfile` in the current directory (e.g. your application). Just run `up` and get coding! (Plugins / ZSH on Windows)
- awesome-zsh-plugins - appup - Adds `start`, `stop`, `up` and `down` commands when it detects a `docker-compose.yml` or `Vagrantfile` in the current directory (e.g. your application). Just run `up` and get coding! (Plugins / Zinit (née zplugin))
README
# AppUp
> The command that can save you typing 15 characters or more, each time!
[](https://circleci.com/gh/Cloudstek/zsh-plugin-appup)
This plugins adds `start`, `restart`, `stop`, `up` and `down` commands when it detects a docker-compose or Vagrant file
in the current directory (e.g. your application). Just run `up` and get coding! This saves you typing `docker-compose`
or `vagrant` every time or aliasing them. Also gives you one set of commands that work for both environments.
### Docker
Aside from simply running `up`, you can also extend your configuration by running `up `, which will
run `docker-compose` with both `docker-compose.yml` and extend it with `docker-compose..yml`. For more on
extending please see the [official docker documentation](https://docs.docker.com/compose/extends). Additional arguments
will be directly supplied to the docker-compose.
### Vagrant
Vagrant doesn't have a `down`, `restart`, `start` or `stop` commands natively but don't worry, that's been taken care of
and running those commands will actually run vagrant's equivalent commands. Additional arguments will be directly
supplied to vagrant.
### Command mapping
| Command | Vagrant command | Docker command |
|---------|------------------------------------------------------------|---------------------------------------------------------------|
| up | [up](https://www.vagrantup.com/docs/cli/up.html) | [up](https://docs.docker.com/compose/reference/up/) |
| down | [destroy](https://www.vagrantup.com/docs/cli/destroy.html) | [down](https://docs.docker.com/compose/reference/down/) |
| start | [up](https://www.vagrantup.com/docs/cli/up.html) | [start](https://docs.docker.com/compose/reference/start/) |
| restart | [reload](https://www.vagrantup.com/docs/cli/reload.html) | [restart](https://docs.docker.com/compose/reference/restart/) |
| stop | [halt](https://www.vagrantup.com/docs/cli/halt.html) | [stop](https://docs.docker.com/compose/reference/stop/) |
| enter | | [exec](https://docs.docker.com/compose/reference/exec/) /bin/bash -l (or custom command/shell, e.g. with `enter /bin/sh`) |
## Installation
### oh-my-zsh
1. Clone this repository in `$ZSH_CUSTOM/plugins/appup`:
```bash
git clone https://github.com/Cloudstek/zsh-plugin-appup.git "$ZSH_CUSTOM/plugins/appup"
```
2. Edit `~/.zshrc` and add `appup` to the list of plugins
### Plain ZSH
1. Clone this repository somewhere
2. Edit your `~/.zshrc` and add this line near the bottom of the file:
```bash
source path/to/the/repository/appup.plugin.zsh
```
## Updating
1. Go to the directory where you cloned the plugin repository
2. Run `git pull origin master`
## Configuration options
AppUp has a few configuration options to customise its behaviour. Please make sure you define these in `~/.zshrc`
*before* you load any plugins.
Currently these options only affect docker.
| Name | Values | Default | Description |
|----------------------|------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| APPUP_CHECK_STARTED | true/false | true | Enable/disable checking if docker is running completely. |
| APPUP_DOCKER_MACHINE | true/false | true | If both docker (e.g. Docker Desktop) and docker-machine are installed, check if docker-machine (when `true`) or docker (when `false`) is running. |
| APPUP_LOAD_ENVS | true/false | true | When true, load .env, .env.local, .env.docker and .env.docker.local if they exist with `docker compose --env-file`. |