Skip to content

README.md

Latest commit

 

History

History
79 lines (48 loc) · 2.76 KB

README.md

File metadata and controls

79 lines (48 loc) · 2.76 KB
Raw

Temporal Plugin for OpenAI Codex

This repository provides an OpenAI Codex plugin for working with Temporal — developing applications, using the CLI, managing server, and working with Temporal Cloud.

Warning

This plugin is in Public Preview, and will continue to evolve and improve. We would love to hear your feedback - positive or negative - over in the Community Slack, in the #topic-ai channel

Installation

Install from the Codex marketplace (recommended)

The Temporal plugin is published in the Codex plugin marketplace.

Codex app:

  1. Open the plugins menu.
  2. Search for temporal.
  3. Click + (or Add to Codex) next to the plugin.

Codex CLI:

  1. Run /plugins.
  2. Search for temporal.
  3. Select "Install plugin"

Restart Codex after installing.

Repo-scoped

Install the plugin locally through this repo:

  1. Clone this repo into your project root:

    cd your-project
git clone https://github.com/temporalio/codex-temporal-plugin.git

  2. Copy the marketplace and plugin files into your project:

    # Create the directories Codex looks for at the repo root
mkdir -p .agents/plugins plugins

# Copy the plugin
cp -r codex-temporal-plugin/plugins/temporal plugins/

# Copy the marketplace catalog
cp codex-temporal-plugin/.agents/plugins/marketplace.json .agents/plugins/

    If you already have a .agents/plugins/marketplace.json, merge the temporal entry from the one in this repo into your existing file's plugins array.

  3. Optionally, remove the cloned repo:

    rm -rf codex-temporal-plugin

  4. Restart Codex and open the plugin directory. In the marketplace dropdown, switch from OpenAI to Temporal, then click the + button to install the plugin.

What's Included

  • temporal-developer skill — Comprehensive guidance for developing Temporal applications: creating workflows, activities, and workers; handling signals, queries, and updates; debugging non-determinism errors; implementing saga patterns, versioning strategies, and testing approaches across Python, TypeScript, Go, and Java SDKs.

Standalone Skill

The skill content is derived from temporalio/skill-temporal-developer. If you only need the skill without the plugin wrapper, you can install it directly from that repo.

Other Coding Agents

License

MIT