{"id":18348776,"url":"https://github.com/cloudstek/zsh-plugin-appup","last_synced_at":"2025-04-06T09:31:49.812Z","repository":{"id":150828676,"uuid":"124380916","full_name":"Cloudstek/zsh-plugin-appup","owner":"Cloudstek","description":"The command that can save you typing 15 characters or more, each time!","archived":false,"fork":false,"pushed_at":"2023-06-06T09:44:18.000Z","size":30,"stargazers_count":17,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-21T21:11:57.380Z","etag":null,"topics":["aliases","docker","docker-compose","oh-my-zsh","oh-my-zsh-plugin","vagrant","zsh"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cloudstek.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2018-03-08T11:18:21.000Z","updated_at":"2025-03-17T23:14:08.000Z","dependencies_parsed_at":"2024-01-03T04:15:48.725Z","dependency_job_id":"1c0d11b8-1dd6-414d-9d75-b6ba34d99ead","html_url":"https://github.com/Cloudstek/zsh-plugin-appup","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cloudstek%2Fzsh-plugin-appup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cloudstek%2Fzsh-plugin-appup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cloudstek%2Fzsh-plugin-appup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cloudstek%2Fzsh-plugin-appup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cloudstek","download_url":"https://codeload.github.com/Cloudstek/zsh-plugin-appup/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247463744,"owners_count":20942935,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aliases","docker","docker-compose","oh-my-zsh","oh-my-zsh-plugin","vagrant","zsh"],"created_at":"2024-11-05T21:19:13.764Z","updated_at":"2025-04-06T09:31:49.544Z","avatar_url":"https://github.com/Cloudstek.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AppUp\n\n\u003e The command that can save you typing 15 characters or more, each time!\n\n[![CircleCI](https://circleci.com/gh/Cloudstek/zsh-plugin-appup.svg?style=svg)](https://circleci.com/gh/Cloudstek/zsh-plugin-appup)\n\nThis plugins adds `start`, `restart`, `stop`, `up` and `down` commands when it detects a docker-compose or Vagrant file\nin the current directory (e.g. your application). Just run `up` and get coding! This saves you typing `docker-compose`\nor `vagrant` every time or aliasing them. Also gives you one set of commands that work for both environments.\n\n### Docker\n\nAside from simply running `up`, you can also extend your configuration by running `up \u003cname\u003e`, which will\nrun `docker-compose` with both `docker-compose.yml` and extend it with `docker-compose.\u003cname\u003e.yml`. For more on\nextending please see the [official docker documentation](https://docs.docker.com/compose/extends). Additional arguments\nwill be directly supplied to the docker-compose.\n\n### Vagrant\n\nVagrant doesn't have a `down`, `restart`, `start` or `stop` commands natively but don't worry, that's been taken care of\nand running those commands will actually run vagrant's equivalent commands. Additional arguments will be directly\nsupplied to vagrant.\n\n### Command mapping\n\n| Command | Vagrant command                                            | Docker command                                                |\n|---------|------------------------------------------------------------|---------------------------------------------------------------|\n| up      | [up](https://www.vagrantup.com/docs/cli/up.html)           | [up](https://docs.docker.com/compose/reference/up/)           |\n| down    | [destroy](https://www.vagrantup.com/docs/cli/destroy.html) | [down](https://docs.docker.com/compose/reference/down/)       |\n| start   | [up](https://www.vagrantup.com/docs/cli/up.html)           | [start](https://docs.docker.com/compose/reference/start/)     |\n| restart | [reload](https://www.vagrantup.com/docs/cli/reload.html)   | [restart](https://docs.docker.com/compose/reference/restart/) |\n| stop    | [halt](https://www.vagrantup.com/docs/cli/halt.html)       | [stop](https://docs.docker.com/compose/reference/stop/)       |\n| enter   |                                                            | [exec](https://docs.docker.com/compose/reference/exec/) /bin/bash -l (or custom command/shell, e.g. with `enter /bin/sh`)      |\n\n## Installation\n\n### oh-my-zsh\n\n1. Clone this repository in `$ZSH_CUSTOM/plugins/appup`:\n\n   ```bash\n   git clone https://github.com/Cloudstek/zsh-plugin-appup.git \"$ZSH_CUSTOM/plugins/appup\"\n   ```\n2. Edit `~/.zshrc` and add `appup` to the list of plugins\n\n### Plain ZSH\n\n1. Clone this repository somewhere\n\n2. Edit your `~/.zshrc` and add this line near the bottom of the file:\n\n   ```bash\n   source path/to/the/repository/appup.plugin.zsh\n   ```\n\n## Updating\n\n1. Go to the directory where you cloned the plugin repository\n2. Run `git pull origin master`\n\n## Configuration options\n\nAppUp has a few configuration options to customise its behaviour. Please make sure you define these in `~/.zshrc`\n*before* you load any plugins.\n\nCurrently these options only affect docker.\n\n| Name                 | Values     | Default | Description                                                                                                                                       |\n|----------------------|------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| APPUP_CHECK_STARTED  | true/false | true    | Enable/disable checking if docker is running completely.                                                                                          |\n| 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. |\n| 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`.                               | \n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudstek%2Fzsh-plugin-appup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudstek%2Fzsh-plugin-appup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudstek%2Fzsh-plugin-appup/lists"}