From 766c18e7d7db40a7a00883f5be2935618f472902 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20Cornell=C3=A0?= Date: Sat, 22 Nov 2025 18:09:50 +0100 Subject: [PATCH] Improve README formatting --- plugins/pulumi/README.md | 55 ++++++++++++++++++---------------------- 1 file changed, 25 insertions(+), 30 deletions(-) diff --git a/plugins/pulumi/README.md b/plugins/pulumi/README.md index 9d3af1d52..4c771964b 100644 --- a/plugins/pulumi/README.md +++ b/plugins/pulumi/README.md @@ -1,46 +1,41 @@ -# Pulumi Oh My Zsh Plugin +# Pulumi + +This is an **Oh My Zsh plugin** for the [**Pulumi CLI**](https://www.pulumi.com/docs/iac/cli/), +an Infrastructure as Code (IaC) tool for building, deploying and managing cloud infrastucture. + +This plugin provides: -This is an **Oh My Zsh plugin** for the **Pulumi CLI**, providing: - 🚀 Short, intuitive aliases for common Pulumi commands - 🎯 Auto-completion support for Pulumi -## 📦 Installation - -To use this plugin, add `pulumi` to the plugins array in your `.zshrc` file: +To use it, add `pulumi` to the plugins array in your `.zshrc` file: ```zsh plugins=(... pulumi) ``` -Then run ```source ~/.zshrc``` +## ⚡ Aliases ---- - -## ⚡ Short Aliases - -| Alias | Command | Description | -|--------|--------------------------|----------------------------------| -| `p` | `pulumi` | Shortcut for Pulumi CLI | -| `pu` | `pulumi up` | Deploy infrastructure | -| `pp` | `pulumi preview` | Show planned changes | -| `pd` | `pulumi destroy` | Destroy all resources | -| `pr` | `pulumi refresh` | Refresh state from cloud | -| `ps` | `pulumi stack` | Show stack details | -| `pss` | `pulumi stack select` | Switch stack | -| `psh` | `pulumi stack history` | Show stack history | -| `psi` | `pulumi stack init` | Initialize a new stack | -| `psl` | `pulumi stack ls` | List available stacks | -| `pso` | `pulumi stack output` | Show stack outputs | -| `plog` | `pulumi logs -f` | Tail Pulumi logs in real-time | -| `pcs` | `pulumi config set` | Set Pulumi configuration | - ---- +| Alias | Command | Description | +| -------- | ---------------------- | ----------------------------- | +| `pul` | `pulumi` | Shortcut for Pulumi CLI | +| `pulcs` | `pulumi config set` | Set Pulumi configuration | +| `puld` | `pulumi destroy` | Destroy all resources | +| `pullog` | `pulumi logs -f` | Tail Pulumi logs in real-time | +| `pulp` | `pulumi preview` | Show planned changes | +| `pulr` | `pulumi refresh` | Refresh state from cloud | +| `puls` | `pulumi stack` | Show stack details | +| `pulsh` | `pulumi stack history` | Show stack history | +| `pulsi` | `pulumi stack init` | Initialize a new stack | +| `pulsl` | `pulumi stack ls` | List available stacks | +| `pulso` | `pulumi stack output` | Show stack outputs | +| `pulss` | `pulumi stack select` | Switch stack | +| `pulu` | `pulumi up` | Deploy infrastructure | ## 🎯 Autocompletion -If `pulumi gen-completion zsh` is available, this plugin **automatically enables Pulumi auto-completion**. ---- +If `pulumi gen-completion zsh` is available, this plugin **automatically loads Pulumi auto-completion**. ## 🛠️ Contribution -Feel free to open an issue or PR for improvements! 🚀 +Feel free to open an issue or PR for improvements! 🚀