From 6226988ae14d0644f5ffd450d7e0523f0a222521 Mon Sep 17 00:00:00 2001 From: Sahil Rathee Date: Mon, 28 Oct 2024 15:06:40 +0530 Subject: [PATCH] updated README.md for podman-compose --- plugins/podman-compose/README.md | 66 +++++++++++++------------------- plugins/zsh-autosuggestions | 1 + plugins/zsh-syntax-highlighting | 1 + 3 files changed, 29 insertions(+), 39 deletions(-) create mode 160000 plugins/zsh-autosuggestions create mode 160000 plugins/zsh-syntax-highlighting diff --git a/plugins/podman-compose/README.md b/plugins/podman-compose/README.md index 99daa28cd..7a0474314 100644 --- a/plugins/podman-compose/README.md +++ b/plugins/podman-compose/README.md @@ -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 -plugins=(... podman) +plugins=(... podman-compose) ``` ## Aliases -| Alias | Command | Description | -| :------ | :-------------------------------------------- | :--------------------------------------------------------------------------------------- | -| pbl | `podman build` | Build an image from a Dockerfile | -| pcin | `podman container inspect` | Display detailed information on one or more containers | -| pcls | `podman container ls` | List all the running podman containers | -| pclsa | `podman container ls --all` | List all running and stopped containers | -| pib | `podman image build` | Build an image from a Dockerfile (same as podman build) | -| pii | `podman image inspect` | Display detailed information on one or more images | -| pils | `podman image ls` | List podman images | -| pipu | `podman image push` | Push an image or repository to a remote registry | -| pirm | `podman image rm` | Remove one or more images | -| pit | `podman image tag` | Add a name and tag to a particular image | -| plo | `podman container logs` | Fetch the logs of a podman container | -| pnc | `podman network create` | Create a new network | -| pncn | `podman network connect` | Connect a container to a network | -| pndcn | `podman network disconnect` | Disconnect a container from a network | -| pni | `podman network inspect` | Return information about one or more networks | -| pnls | `podman network ls` | List all networks the engine daemon knows about, including those spanning multiple hosts | -| pnrm | `podman network rm` | Remove one or more networks | -| ppo | `podman container port` | List port mappings or a specific mapping for the container | -| ppu | `podman pull` | Pull an image or a repository from a registry | -| 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 | +| Alias | Command | Description | +| :------ | :-------------------------------------------- | :--------------------------------------------------------------------------------------- | +| pco | `podman-compose` | Alias for podman-compose or podman compose | +| pcb | `podman-compose build` | Build images for all services defined in the compose file | +| pce | `podman-compose exec` | Execute a command in a running container defined in the compose file | +| pcps | `podman-compose ps` | List all containers defined in the compose project | +| pcrestart | `podman-compose restart` | Restart all or specific containers in the compose project | +| pcrm | `podman-compose rm` | Remove stopped containers and networks | +| pcr | `podman-compose run` | Run a one-off command in a new container | +| pcstop | `podman-compose stop` | Stop all running containers in the compose project | +| pcup | `podman-compose up` | Create and start all containers defined in the compose file | +| pcupb | `podman-compose up --build` | Build and start all services | +| pcupd | `podman-compose up -d` | Start all services in detached mode | +| pcupdb | `podman-compose up -d --build` | Build images if needed, then start all services in detached mode | +| pcdn | `podman-compose down` | Stop and remove containers, networks, images, and volumes | +| pcl | `podman-compose logs` | Display logs from all containers in the compose project | +| pclf | `podman-compose logs -f` | Follow logs output in real-time | +| pclF | `podman-compose logs -f --tail 0` | Follow logs and display only new output | +| pcpull | `podman-compose pull` | Pull service images | +| pcstart | `podman-compose start` | Start all stopped containers | +| pck | `podman-compose kill` | Forcefully stop all running containers | + + diff --git a/plugins/zsh-autosuggestions b/plugins/zsh-autosuggestions new file mode 160000 index 000000000..c3d4e576c --- /dev/null +++ b/plugins/zsh-autosuggestions @@ -0,0 +1 @@ +Subproject commit c3d4e576c9c86eac62884bd47c01f6faed043fc5 diff --git a/plugins/zsh-syntax-highlighting b/plugins/zsh-syntax-highlighting new file mode 160000 index 000000000..e0165eaa7 --- /dev/null +++ b/plugins/zsh-syntax-highlighting @@ -0,0 +1 @@ +Subproject commit e0165eaa730dd0fa321a6a6de74f092fe87630b0