p5

P5

Pulumi was too long.

A TUI application to help you manage your Pulumi stacks.

Note: This project (including this README) was largely generated with the assistance of LLMs.

Installation

go install github.com/rfhold/p5/cmd/p5@latest

Features

• Stack Management: View and switch between Pulumi stacks
• Resource Browser: Explore resources in your stack with a tree view
• Preview Operations: Run up, refresh, and destroy previews
• Execute Operations: Apply changes directly from the TUI
• Visual Selection: Select multiple resources for targeted operations
• Resource Import: Import existing resources into Pulumi state
• State Management: Delete resources from state
• History View: Browse stack update history
• Plugin System: Extensible authentication via plugins

Usage

# Start in current directory
p5

# Start in a specific directory
p5 -C /path/to/pulumi/project

# Start with a specific stack
p5 -s dev

# Start with a preview operation
p5 up       # Start with up preview
p5 refresh  # Start with refresh preview
p5 destroy  # Start with destroy preview

Command Line Options

Keybindings

Navigation

Views

Preview Operations (lowercase)

Execute Operations (Ctrl+key)

Resource Flags

Visual Selection

Use visual mode to select multiple resources, then apply flags or operations to all selected.

Resource Actions

General

Architecture

┌─────────────────────────────────────────────────────────────┐
│                         p5 TUI                              │
├─────────────────────────────────────────────────────────────┤
│  cmd/p5/           - Bubble Tea application                 │
│  ├── model.go      - State management and types             │
│  ├── view.go       - Rendering logic                        │
│  ├── commands.go   - Async operations (Bubble Tea commands) │
│  ├── messages.go   - Message types for update loop          │
│  └── update_*.go   - Update handlers by domain              │
├─────────────────────────────────────────────────────────────┤
│  internal/ui/      - Reusable UI components                 │
│  ├── resourcelist  - Resource browser with tree view        │
│  ├── details       - Resource detail panel                  │
│  ├── modals        - Import, confirm, error dialogs         │
│  └── selectors     - Stack and workspace selectors          │
├─────────────────────────────────────────────────────────────┤
│  internal/pulumi/  - Pulumi Automation API integration      │
│  ├── operations    - Preview and execute operations         │
│  ├── resources     - Stack resource queries                 │
│  └── history       - Stack update history                   │
├─────────────────────────────────────────────────────────────┤
│  internal/plugins/ - Plugin system for authentication       │
│  ├── builtins      - In-process plugins (env, kubernetes)   │
│  └── grpc          - External plugin support via go-plugin  │
└─────────────────────────────────────────────────────────────┘

Plugin System

p5 supports plugins for authentication with configurable program and stack settings. Plugins can access both program-level configuration (from Pulumi.yaml) and stack-specific configuration (from Pulumi.{stack}.yaml), allowing for flexible authentication across different environments.

Builtin Plugins

• env: Load environment variables from files, static config, or commands
• kubernetes: Kubernetes context management

Example Configuration

# p5.toml (global defaults)
[plugins.env.config]
path = ".env"

# Pulumi.yaml (program-level)
p5:
  plugins:
    env:
      config:
        sources:
          - type: "file"
            path: ".env.defaults"

# Pulumi.dev.yaml (stack-level)
config:
  aws:region: us-west-2
  p5:plugins:
    env:
      config:
        sources: '[{"type":"file","path":".env.dev"}]'

See docs/plugins.md for detailed plugin documentation including:

• Complete configuration options and precedence
• External plugin development guide
• Program and stack configurability examples
• Authentication lifecycle and caching

Motivation

Pulumi is a great tool, but the CLI is not very user friendly. I wanted to create a TUI application that would make it easier to manage Pulumi stacks and programs. With p5 I should be able to rapidly iterate over IaC changes while also assisting in complicated state manipulation.

Development

Prerequisites

• Go 1.21+
• A Pulumi project for testing

Running Locally

# Build and run
go build -o /dev/null ./cmd/p5 && ./scripts/dev.sh -C programs/simple

# View output in tmux pane
./scripts/view.sh

Project Structure

.
├── cmd/p5/          # Main application
├── internal/
│   ├── plugins/     # Plugin system
│   ├── pulumi/      # Pulumi API integration
│   └── ui/          # UI components
├── pkg/plugin/      # Public plugin interface
├── docs/            # Documentation
└── test/            # Test Pulumi projects

Recording Demo

The demo GIF is recorded using VHS. To regenerate it:

# Build and run VHS to generate demo.gif
./scripts/vhs.sh

# Or run steps separately:
./scripts/vhs.sh --build-only  # Only build the Docker image
./scripts/vhs.sh --run-only    # Only run VHS (image must exist)

License

See LICENSE for details.