linux/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-26 21:51:05 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix(README): fix docker aliases documentation

Browse source
This commit is contained in:
baltic-tea 2024-11-10 16:53:54 +03:00 committed by GitHub
parent 3914197aa2
commit e12ff3d828
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 55 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

103
plugins/docker/README.md
View file

@ -41,53 +41,60 @@ zstyle ':omz:plugins:docker' legacy-completion yes
## Aliases ## Aliases
| Alias | Command | Description | | Alias | Command | Description |
| :------ | :------------------------------- | :--------------------------------------------------------------------------------------- | | :------- | :---------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------- |
| dbl | `docker build` | Build an image from a Dockerfile | | dbl | `docker build` | Build an image from a Dockerfile |
| dcin | `docker container inspect` | Display detailed information on one or more containers | | dcin | `docker container inspect` | Display detailed information on one or more containers |
| dcls | `docker container ls` | List all the running docker containers | | dcls | `docker container ls` | List all the running docker containers |
| dclsa | `docker container ls -a` | List all running and stopped containers | | dclsa | `docker container ls -a` | List all running and stopped containers |
| dib | `docker image build` | Build an image from a Dockerfile (same as docker build) | | dib | `docker image build` | Build an image from a Dockerfile (same as docker build) |
| dii | `docker image inspect` | Display detailed information on one or more images | | dii | `docker image inspect` | Display detailed information on one or more images |
| dils | `docker image ls` | List docker images | | dils | `docker image ls` | List docker images |
| dipu | `docker image push` | Push an image or repository to a remote registry | | dipu | `docker image push` | Push an image or repository to a remote registry |
| dirm | `docker image rm` | Remove one or more images | | dirm | `docker image rm` | Remove one or more images |
| dit | `docker image tag` | Add a name and tag to a particular image | | dit | `docker image tag` | Add a name and tag to a particular image |
| dkil | `docker kill` | Kill one or more running containers | | dkil | `docker kill` | Kill one or more running containers |
| dlo | `docker container logs` | Fetch the logs of a docker container | | dlo | `docker container logs` | Fetch the logs of a docker container |
| dlof | `docker container logs --follow` | Fetch and follow the logs of a docker container | | dlof | `docker container logs --follow` | Fetch and follow the logs of a docker container |
| dnc | `docker network create` | Create a new network | | dnc | `docker network create` | Create a new network |
| dncn | `docker network connect` | Connect a container to a network | | dncn | `docker network connect` | Connect a container to a network |
| dndcn | `docker network disconnect` | Disconnect a container from a network | | dndcn | `docker network disconnect` | Disconnect a container from a network |
| dni | `docker network inspect` | Return information about one or more networks | | dni | `docker network inspect` | Return information about one or more networks |
| dnls | `docker network ls` | List all networks the engine daemon knows about, including those spanning multiple hosts | | dnls | `docker network ls` | List all networks the engine daemon knows about, including those spanning multiple hosts |
| dnrm | `docker network rm` | Remove one or more networks | | dnrm | `docker network rm` | Remove one or more networks |
| dpo | `docker container port` | List port mappings or a specific mapping for the container | | dpo | `docker container port` | List port mappings or a specific mapping for the container |
| dpu | `docker pull` | Pull an image or a repository from a registry | | dpu | `docker pull` | Pull an image or a repository from a registry |
| dpsh | `docker push` | Upload an image to a registry | | dpsh | `docker push` | Upload an image to a registry |
| dritrm | `docker container run --rm -it` | Create a new container, start it in an interactive shell and automatically remove it | | dritrm | `docker container run --rm -it` | Create a new container, start it in an interactive shell and automatically remove it |
| dr | `docker container run` | Create a new container and start it using the specified command | | dr | `docker container run` | Create a new container and start it using the specified command |
| drit | `docker container run -it` | Create a new container and start it in an interactive shell | | drit | `docker container run -it` | Create a new container and start it in an interactive shell |
| drm | `docker container rm` | Remove the specified container(s) | | dritbash | `docker run -it --entrypoint /bin/bash` | Create a new container and start it in an interactive mode with Bash |
| drm! | `docker container rm -f` | Force the removal of a running container (uses SIGKILL) | | dritp | `docker container run -it -v $PWD:/pwd -w /pwd` | Create a new container and start it in an interactive mode, mounting current directory as `/pwd` |
| dst | `docker container start` | Start one or more stopped containers | | dritprm | `docker container run --rm -it -v $PWD:/pwd -w /pwd` | Create a new container and start it in an interactive mode with auto-removal, mounting current directory as `/pwd` |
| drs | `docker container restart` | Restart one or more containers | | dritsh | `docker run -it --entrypoint /bin/sh` | Create a new container and start it in an interactive mode with shell |
| dsta | `docker stop $(docker ps -q)` | Stop all running containers | | dritshp | `docker run -it --entrypoint /bin/sh -v $PWD:/pwd -w /pwd` | Create a new container and start it in an interactive mode with shell, mounting current directory as `/pwd` |
| dstat | `docker container stats` | Display a live stream of containers resource usage statistics | | drm | `docker container rm` | Remove the specified container(s) |
| dstp | `docker container stop` | Stop one or more running containers | | drm! | `docker container rm -f` | Force the removal of a running container (uses SIGKILL) |
| dtop | `docker top` | Display the running processes of a container | | drma! | `docker container ls -a -q \| xargs docker container rm -f` | Force the removal all containers |
| dvi | `docker volume inspect` | Display detailed information about one or more volumes | | drp | `docker container run -v $PWD:/pwd -w /pwd` | Run a container with the current directory mounted as `/pwd` |
| dvls | `docker volume ls` | List all the volumes known to docker | | dst | `docker container start` | Start one or more stopped containers |
| dvrm | `docker volume rm` | Remove one or more volumes | | drs | `docker container restart` | Restart one or more containers |
| dcprune | `docker container prune` | Cleanup dangling containers | | dsta | `docker stop $(docker ps -q)` | Stop all running containers |
| diprune | `docker image prune` | Cleanup dangling images | | dstat | `docker container stats` | Display a live stream of containers resource usage statistics |
| dvprune | `docker volume prune` | Cleanup dangling volumes | | dstp | `docker container stop` | Stop one or more running containers |
| dxc | `docker container exec` | Run a new command in a running container | | dtop | `docker top` | Display the running processes of a container |
| dxcit | `docker container exec -it` | Run a new command in a running container in an interactive shell | | dvi | `docker volume inspect` | Display detailed information about one or more volumes |
| dvls | `docker volume ls` | List all the volumes known to docker |
| dvrm | `docker volume rm` | Remove one or more volumes |
| dcprune | `docker container prune` | Cleanup dangling containers |
| diprune | `docker image prune` | Cleanup dangling images |
| dvprune | `docker volume prune` | Cleanup dangling volumes |
| dxc | `docker container exec` | Run a new command in a running container |
| dxcit | `docker container exec -it` | Run a new command in a running container in an interactive shell |
## Custom functions (pseudo-aliases) ## Custom functions (pseudo-aliases)
| Name | Function | Description | | Name | Function | Description |
| :------ | :--------------------------------------------- | :-------------------------------------------------------- | | :------- | :---------------------------------------------- | :---------------------------------------------------------------------- |
| dxcsh | `dxcsh() { docker exec -it "$@" /bin/sh }` | Run a interactive shell inside a running docker container | | dxcsh | `dxcsh() { docker exec -it "$@" /bin/sh }` | Run a interactive shell inside a running docker container |
| dxcbash | `dxcbash() { docker exec -it "$@" /bin/bash }` | Run a interactive bash inside a running docker container | | dxcbash | `dxcbash() { docker exec -it "$@" /bin/bash }` | Run a interactive bash inside a running docker container |