ohmyzsh/plugins/pulumi/README.md
2025-03-27 18:03:37 +02:00

56 lines
2.1 KiB
Markdown

# Pulumi Oh My Zsh Plugin
This is an **Oh My Zsh plugin** for the **Pulumi CLI**, providing:
- 🚀 Short, intuitive aliases for common Pulumi commands
- 🎯 Auto-completion support for Pulumi
- 🔥 A **fuzzy stack selector** using `fzf`
## 📦 Installation
### **Option 1: Manual Installation**
1. Clone this repository into your Oh My Zsh custom plugins folder:
```bash
git clone https://github.com/YOUR_GITHUB_USERNAME/zsh-pulumi ~/.oh-my-zsh/custom/plugins/pulumi
```
2. Enable the plugin in `~/.zshrc` by adding `pulumi` to your plugins list:
```zsh
plugins=(... pulumi)
```
3. Restart your shell or run:
```bash
source ~/.zshrc
```
### **Option 2: Submit to Oh My Zsh**
(Once merged into Oh My Zsh, users can just add `pulumi` to their `.zshrc` plugins list.)
---
## ⚡ 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 |
---
## 🎯 Autocompletion
If `pulumi gen-completion zsh` is available, this plugin **automatically enables Pulumi auto-completion**.
---
## 🛠️ Contribution
Feel free to open an issue or PR for improvements! 🚀