updated README.md for podman-compose

This commit is contained in:
Sahil Rathee 2024-10-28 15:06:40 +05:30
parent 4744aa8bd1
commit 6226988ae1
3 changed files with 29 additions and 39 deletions

View File

@ -1,47 +1,35 @@
# Podman plugin # Podman Compose Plugin
This plugin adds auto-completion and aliases for [podman](https://podman.io/). This plugin provides aliases for working with `podman-compose` (or `podman compose`, based on availability) to simplify multi-container Podman workflows.
To use it add `podman` to the plugins array in your zshrc file. To use it, add `podman-compose` to the plugins array in your `.zshrc` file.
```zsh ```zsh
plugins=(... podman) plugins=(... podman-compose)
``` ```
## Aliases ## Aliases
| Alias | Command | Description | | Alias | Command | Description |
| :------ | :-------------------------------------------- | :--------------------------------------------------------------------------------------- | | :------ | :-------------------------------------------- | :--------------------------------------------------------------------------------------- |
| pbl | `podman build` | Build an image from a Dockerfile | | pco | `podman-compose` | Alias for podman-compose or podman compose |
| pcin | `podman container inspect` | Display detailed information on one or more containers | | pcb | `podman-compose build` | Build images for all services defined in the compose file |
| pcls | `podman container ls` | List all the running podman containers | | pce | `podman-compose exec` | Execute a command in a running container defined in the compose file |
| pclsa | `podman container ls --all` | List all running and stopped containers | | pcps | `podman-compose ps` | List all containers defined in the compose project |
| pib | `podman image build` | Build an image from a Dockerfile (same as podman build) | | pcrestart | `podman-compose restart` | Restart all or specific containers in the compose project |
| pii | `podman image inspect` | Display detailed information on one or more images | | pcrm | `podman-compose rm` | Remove stopped containers and networks |
| pils | `podman image ls` | List podman images | | pcr | `podman-compose run` | Run a one-off command in a new container |
| pipu | `podman image push` | Push an image or repository to a remote registry | | pcstop | `podman-compose stop` | Stop all running containers in the compose project |
| pirm | `podman image rm` | Remove one or more images | | pcup | `podman-compose up` | Create and start all containers defined in the compose file |
| pit | `podman image tag` | Add a name and tag to a particular image | | pcupb | `podman-compose up --build` | Build and start all services |
| plo | `podman container logs` | Fetch the logs of a podman container | | pcupd | `podman-compose up -d` | Start all services in detached mode |
| pnc | `podman network create` | Create a new network | | pcupdb | `podman-compose up -d --build` | Build images if needed, then start all services in detached mode |
| pncn | `podman network connect` | Connect a container to a network | | pcdn | `podman-compose down` | Stop and remove containers, networks, images, and volumes |
| pndcn | `podman network disconnect` | Disconnect a container from a network | | pcl | `podman-compose logs` | Display logs from all containers in the compose project |
| pni | `podman network inspect` | Return information about one or more networks | | pclf | `podman-compose logs -f` | Follow logs output in real-time |
| pnls | `podman network ls` | List all networks the engine daemon knows about, including those spanning multiple hosts | | pclF | `podman-compose logs -f --tail 0` | Follow logs and display only new output |
| pnrm | `podman network rm` | Remove one or more networks | | pcpull | `podman-compose pull` | Pull service images |
| ppo | `podman container port` | List port mappings or a specific mapping for the container | | pcstart | `podman-compose start` | Start all stopped containers |
| ppu | `podman pull` | Pull an image or a repository from a registry | | pck | `podman-compose kill` | Forcefully stop all running containers |
| pr | `podman container run` | Create a new container and start it using the specified command |
| prit | `podman container run --interactive --tty` | Create a new container and start it in an interactive shell |
| prm | `podman container rm` | Remove the specified container(s) |
| prm! | `podman container rm --force` | Force the removal of a running container (uses SIGKILL) |
| pst | `podman container start` | Start one or more stopped containers |
| prs | `podman container restart` | Restart one or more containers |
| psta | `podman stop $(podman ps -q)` | Stop all running containers |
| pstp | `podman container stop` | Stop one or more running containers |
| ptop | `podman top` | Display the running processes of a container |
| pvi | `podman volume inspect` | Display detailed information about one or more volumes |
| pvls | `podman volume ls` | List all the volumes known to podman |
| pvprune | `podman volume prune` | Cleanup dangling volumes |
| pxc | `podman container exec` | Run a new command in a running container |
| pxcit | `podman container exec --interactive --tty` | Run a new command in a running container in an interactive shell |

@ -0,0 +1 @@
Subproject commit c3d4e576c9c86eac62884bd47c01f6faed043fc5

@ -0,0 +1 @@
Subproject commit e0165eaa730dd0fa321a6a6de74f092fe87630b0