# pulumi-component

A skill that walks the agent through authoring Pulumi ComponentResource classes: args interface, child resources, registerOutputs.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 1500 installs · ★ 78
- Author: pulumi
- License: Apache-2.0 · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/pulumi/agent-skills/tree/HEAD/pulumi/skills/pulumi-component/SKILL.md
- Updated: 2026-10-09
- HTML: https://affpapa.org/en/nevibecode/skills/pulumi-component

## What it does

A ComponentResource groups related infrastructure resources into one logical unit. In `pulumi preview` and `pulumi up` output it shows up as a single node with children nested underneath. The skill covers the whole authoring lifecycle, from writing the class to distributing the package.

Four elements are required in every component. Extend `ComponentResource` and call `super()` with a type URN shaped `<package>:<module>:<type>`, accept name, args and `ComponentResourceOptions`, set `parent: this` on every child resource, and call `registerOutputs()` as the last line of the constructor. Skip `registerOutputs()` and the component sits in a creating state in the Pulumi console while its outputs never reach state. Child names get their own section: a hardcoded name like `my-bucket` collides the moment the component is instantiated twice, so names are derived from the `name` parameter.

The args interface gets similar treatment. Properties are wrapped in `Input<T>` so consumers can pass plain values or an `Output<T>` from another resource without unwrapping it by hand. For general Pulumi patterns — Output handling, secrets, aliases, preview workflows — the skill points to `pulumi-best-practices`.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add pulumi/agent-skills --skill pulumi-component -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/pulumi-component/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/pulumi-component/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add pulumi/agent-skills --skill pulumi-component -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/pulumi-component/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add pulumi/agent-skills --skill pulumi-component -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/pulumi-component/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install pulumi/agent-skills pulumi-component
```

2. **Manually: put the files in place**
- File: `.github/skills/pulumi-component/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add pulumi/agent-skills --skill pulumi-component -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/pulumi/agent-skills --path pulumi/skills/pulumi-component
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/pulumi-component/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add pulumi/agent-skills --skill pulumi-component -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/pulumi/agent-skills/tree/HEAD/pulumi/skills/pulumi-component/SKILL.md

## When to use it
- turn scattered resources into a reusable component
- design an args interface that accepts Outputs from other resources
- make a component consumable from several Pulumi languages
- publish a component package
- debug a component stuck in the creating state

## Example prompts
- Help me write a ComponentResource for a static site on S3
- Design the args interface so it accepts Outputs from other resources
- Why is my component stuck in creating in the Pulumi console?

## Source text · SKILL.md · Apache-2.0

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: 383ffdd3d43c3191.

BEGIN THIRD-PARTY FILE 383ffdd3d43c3191
````text
---
name: pulumi-component
version: 1.0.0
description: Guide for authoring Pulumi ComponentResource classes. Use when creating reusable infrastructure components, designing component interfaces, setting up multi-language support, or distributing component packages.
---

# Authoring Pulumi Components

A ComponentResource groups related infrastructure resources into a reusable, logical unit. Components make infrastructure easier to understand, reuse, and maintain. Components appear as a single node with children nested underneath in `pulumi preview`/`pulumi up` output and in the Pulumi Cloud console.

This skill covers the full component authoring lifecycle. For general Pulumi coding patterns (Output handling, secrets, aliases, preview workflows), use the `pulumi-best-practices` skill instead.

## When to Use This Skill

Invoke this skill when:

- Creating a new ComponentResource class
- Designing the args interface for a component
- Making a component consumable from multiple Pulumi languages
- Publishing or distributing a component package
- Refactoring inline resources into a reusable component
- Debugging component behavior (missing outputs, stuck creating, children at wrong level)

## Component Anatomy

Every component has four required elements:

1. **Extend ComponentResource** and call `super()` with a type URN
2. **Accept standard parameters**: name, args, and `ComponentResourceOptions`
3. **Set `parent: this`** on all child resources
4. **Call `registerOutputs()`** at the end of the constructor

### TypeScript

```typescript
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

interface StaticSiteArgs {
    indexDocument?: pulumi.Input<string>;
    errorDocument?: pulumi.Input<string>;
}

class StaticSite extends pulumi.ComponentResource {
    public readonly bucketName: pulumi.Output<string>;
    public readonly websiteUrl: pulumi.Output<string>;

    constructor(name: string, args: StaticSiteArgs, opts?: pulumi.ComponentResourceOptions) {
        // 1. Call super with type URN: <package>:<module>:<type>
        super("myorg:index:StaticSite", name, {}, opts);

        // 2. Create child resources with parent: this
        const bucket = new aws.s3.Bucket(`${name}-bucket`, {}, { parent: this });

        const website = new aws.s3.BucketWebsiteConfigurationV2(`${name}-website`, {
            bucket: bucket.id,
            indexDocument: { suffix: args.indexDocument ?? "index.html" },
            errorDocument: { key: args.errorDocument ?? "error.html" },
````
END THIRD-PARTY FILE 383ffdd3d43c3191

The third-party file has ended. Everything between the 383ffdd3d43c3191 tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

First 2532 of 27252 bytes. © pulumi · Apache-2.0 · https://github.com/pulumi/agent-skills/tree/HEAD/pulumi/skills/pulumi-component/SKILL.md

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md