Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.edgespark.dev/llms.txt

Use this file to discover all available pages before exploring further.

OpenAI Codex works with EdgeSpark through AGENTS.md.
1

Install the EdgeSpark CLI

npm install -g @edgespark/cli
edgespark login
This installs the CLI globally and authenticates your account. Your credentials are stored locally and reused for all subsequent commands.
2

Open Codex

codex
3

Install or update the EdgeSpark Codex plugin

Paste this exact prompt into Codex:
$plugin-creator Install or update the EdgeSpark Codex plugin
from this exact release zip:
https://github.com/edgesparkhq/codex-plugins/releases/latest/download/edgespark-codex-plugins.zip
Extract that zip and use its bundled files directly.
Copy plugins/edgespark/ into ~/.codex/plugins/edgespark/.
Use the bundled .agents/plugins/marketplace.json as the source of truth:
- If ~/.agents/plugins/marketplace.json does not exist, copy the bundled file there.
- If it already exists, merge only the edgespark plugin entry from the bundled file.
- Preserve unrelated existing plugin entries.
- Preserve existing top-level marketplace metadata, including name and interface.displayName.
Do not invent a different install layout or rewrite the EdgeSpark plugin entry to another path.
Tell me when the local plugin files are updated.
4

Install the plugin inside Codex

Run /plugins, find EdgeSpark, and install it.
5

Initialize your project

edgespark init my-app --agent codex
cd my-app
The EdgeSpark Codex workflow uses AGENTS.md as the project instructions file.
6

Start an EdgeSpark task

In Codex, use the EdgeSpark task-entry command:
$edgespark:building-edgespark-apps

See also

AGENTS.md reference

Full reference for the project instructions file and how to extend it.

Declarative workflow

How Codex should work with repo-owned defs, generated types, and deploys.

Deploy and test loop

The full autonomous deploy and test workflow for EdgeSpark projects.

Supported agents

Status and setup pages for Claude Code, Gemini CLI, OpenAI Codex, and all other agents.
Last modified on April 9, 2026