> ## 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 and EdgeSpark

> Set up OpenAI Codex to work with EdgeSpark — install the EdgeSpark Codex plugin, generate AGENTS.md, and build with the public Codex workflow.

OpenAI Codex works with EdgeSpark through `AGENTS.md`.

<Steps>
  <Step title="Install the EdgeSpark CLI">
    ```bash theme={null}
    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.
  </Step>

  <Step title="Open Codex">
    ```bash theme={null}
    codex
    ```
  </Step>

  <Step title="Install or update the EdgeSpark Codex plugin">
    Paste this exact prompt into Codex:

    ```text theme={null}
    $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.
    ```
  </Step>

  <Step title="Install the plugin inside Codex">
    Run `/plugins`, find **EdgeSpark**, and install it.
  </Step>

  <Step title="Initialize your project">
    ```bash theme={null}
    edgespark init my-app --agent codex
    cd my-app
    ```

    The EdgeSpark Codex workflow uses `AGENTS.md` as the project instructions file.
  </Step>

  <Step title="Start an EdgeSpark task">
    In Codex, use the EdgeSpark task-entry command:

    ```text theme={null}
    $edgespark:building-edgespark-apps
    ```
  </Step>
</Steps>

## See also

<Columns cols={2}>
  <Card title="AGENTS.md reference" icon="file-lines" href="/agents/agents-md">
    Full reference for the project instructions file and how to extend it.
  </Card>

  <Card title="Declarative workflow" icon="database" href="/agents/declarative-workflow">
    How Codex should work with repo-owned defs, generated types, and deploys.
  </Card>

  <Card title="Deploy and test loop" icon="rotate" href="/agents/deploy-and-test">
    The full autonomous deploy and test workflow for EdgeSpark projects.
  </Card>

  <Card title="Supported agents" icon="robot" href="/agents/supported-agents">
    Status and setup pages for Claude Code, Gemini CLI, OpenAI Codex, and all other agents.
  </Card>
</Columns>