{"id":31134283,"url":"https://github.com/mdeboer/zsh-plugin-appup","last_synced_at":"2025-12-15T06:05:47.327Z","repository":{"id":150828676,"uuid":"124380916","full_name":"mdeboer/zsh-plugin-appup","owner":"mdeboer","description":"The command that can save you typing 15 characters or more, each time!","archived":false,"fork":false,"pushed_at":"2025-08-14T10:44:55.000Z","size":42,"stargazers_count":18,"open_issues_count":0,"forks_count":3,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-08-14T12:12:34.575Z","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/mdeboer.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,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-03-08T11:18:21.000Z","updated_at":"2025-08-14T10:44:58.000Z","dependencies_parsed_at":"2024-01-03T04:15:48.725Z","dependency_job_id":"1c0d11b8-1dd6-414d-9d75-b6ba34d99ead","html_url":"https://github.com/mdeboer/zsh-plugin-appup","commit_stats":null,"previous_names":["mdeboer/zsh-plugin-appup"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/mdeboer/zsh-plugin-appup","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdeboer%2Fzsh-plugin-appup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdeboer%2Fzsh-plugin-appup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdeboer%2Fzsh-plugin-appup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdeboer%2Fzsh-plugin-appup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mdeboer","download_url":"https://codeload.github.com/mdeboer/zsh-plugin-appup/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdeboer%2Fzsh-plugin-appup/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275725335,"owners_count":25516697,"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","status":"online","status_checked_at":"2025-09-18T02:00:09.552Z","response_time":77,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2025-09-18T06:50:58.801Z","updated_at":"2025-09-18T06:51:03.476Z","avatar_url":"https://github.com/mdeboer.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[![Tests](https://github.com/mdeboer/zsh-plugin-appup/actions/workflows/zunit.yml/badge.svg)](https://github.com/mdeboer/zsh-plugin-appup/actions/workflows/zunit.yml) ![GitHub Issues](https://img.shields.io/github/issues/mdeboer/zsh-plugin-appup) ![GitHub Pull Requests](https://img.shields.io/github/issues-pr/mdeboer/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### 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\n#### Enter command\n\nThere is one extra command that doesn't map to either Vagrant or Docker natively. Currently it is only implemented for\nDocker and allows you to quickly open a shell in a container.\n\n```shell\nenter my-container          # Spawns /bin/bash -l in my-container\nenter my-container /bin/sh  # Spawns /bin/sh in my-container (useful for Alpine based images) \n```\n\n## Installation\n\n### oh-my-zsh\n\n1. Clone this repository to `$ZSH_CUSTOM/plugins/appup`.\n2. Edit your `.zshrc` and add `appup` to the list of plugins.\n\n### Antidote\n\n```shell\nantidote install mdeboer/zsh-plugin-appup\n```\n\n### Antigen\n\n```shell\nantigen bundle mdeboer/zsh-plugin-appup\n```\n\n### ZI\n\n```shell\nzi load mdeboer/zsh-plugin-appup\n```\n\n### Plain ZSH\n\n1. Clone this repository somewhere\n2. Edit your `.zshrc` and `source` the `appup.plugin.zsh` somewhere:\n\n## Configuration options\n\nThis plugin has a few configuration options to customise its behaviour. Please make sure you define these in your\n`.zshrc` file *before* you load any plugins.\n\nFor more information about `zstyle`, see the man page `zshmodules(1)`.\n\n| Option                                       | Values | Default | Description                                                                                                                                   |\n|----------------------------------------------|--------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| `':omz:plugins:appup:docker' check-started`  | yes/no | no      | Enable/disable checking if docker is running.                                                                                                 |\n| `':omz:plugins:appup:docker' docker-machine` | yes/no | no      | If both docker (e.g. Docker Desktop) and docker-machine are installed, check if docker-machine (when `yes`) or docker (when `no`) is running. |\n| `':omz:plugins:appup:docker' env-files`      | array  |         | Additional env files to load (if they exist) when running `up` (adds `--env-file=...` arguments to the docker compose command).               | \n\n### Example\n\n```shell\nzstyle ':omz:plugins:appup:docker' check-started yes\nzstyle ':omz:plugins:appup:docker' docker-machine no\nzstyle ':omz:plugins:appup:docker' env-files .env.foo .env.bar # Will also load .env.foo and/or .env.bar if they exist.\n\n# Load the plugin here...\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdeboer%2Fzsh-plugin-appup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmdeboer%2Fzsh-plugin-appup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdeboer%2Fzsh-plugin-appup/lists"}