codex.md

id	agents.docs.install.codex
title	Install WebDev Agent Kit for Codex
doc_type	user-guide
layer	docs
status	active
publishable	true
local_only	false
tags	docs/install client/codex
parent	[[docs/install/README|Installation Guides]]
related	[[docs/install/gpt-model-routing]] [[docs/install/first-run|First Run And Installation Checks]] [[docs/install/upgrade|Upgrade And Rollback]] [[common/client-adaptation-policy|Client Adaptation Policy]] [[common/mcp-installation-policy|MCP Installation Policy]] [[docs/mcp/README|MCP for WebDev Agent Kit]]
depends_on

Install WebDev Agent Kit for Codex

Before extracting, complete the first-run checks. For an existing installation, use upgrade and rollback to preserve local state.

1. Download the latest Codex package.

2. Extract the archive into the project root. After extraction, the .agents/ directory must be located directly in the root next to the project files.

3. Add the following root-anchored entries to the project's .gitignore so the local agent kit, Codex configuration, generated project context, and root instruction pointer are not committed to the remote repository:

   /.agents/
   /.codex/
   /AGENTS.md

4. Start Codex from the project root and send this prompt:

   Adapt this .agents bundle to my project and create AGENTS.md in the root
   

5. After adaptation, Codex creates .agents/project/ with local information about the stack, architecture, available tools, and important project paths. During subsequent work, this context is updated when the project changes substantially. To request an update manually, send:

   Update the project context after these changes.
   

GPT Subagents During Onboarding

Full adaptation can set up missing local subagent roles. Existing working settings stay in place. Follow GPT model routing. To skip model setup, ask for project facts only. Plan Mode also leaves settings unchanged. After setup, refresh the client and check one real role invocation; a configuration file alone does not show that the role works.

← All installation guides · MCP for WebDev Agent Kit · All documentation