CodexCodex Kit

Getting Started

Local Codex Setup

Install the Codex Kit plugin or skill catalog into local Codex.

Use this page after the base project scaffold is in place.

It covers the two Codex-local integrations: the workspace plugin and the local skill catalog.

These are different scopes: the plugin is project-local, while the skill catalog is user-local.

Installation Scopes

  • Project-local: init scaffolds the repository, while install --target plugin and install --target skills add only those parts into the current project.
  • Project-local MCP: install --target mcp writes the shipped MCP bundle into .codex/config.toml.
  • User-local: install --target skills --scope local copies the shipped skill catalog into ${CODEX_HOME:-~/.codex}/skills for local Codex on the current machine.
  • User-local MCP: install --target mcp --scope local writes the shipped MCP bundle into ${CODEX_HOME:-~/.codex}/config.toml.
  • Run both when you want a repository-specific plugin plus the full Codex Kit skill catalog available in local Codex.
  • After upgrading Codex Kit, use sync-codex to sync both scopes with one command.

Install The Plugin In Codex

Run init or plain install when you want the full project scaffold.

Run install --target plugin when you only want the workspace plugin files in the current project. Codex Kit copies the plugin into .agents/plugins/codex-kit and creates .agents/plugins/marketplace.json with installation: "INSTALLED_BY_DEFAULT".

After that, open the Plugins view in Codex, choose the Codex Kit Local marketplace, and click the + button on Codex Kit.

If you also want the full shipped skill catalog in local Codex, run the full setup command below.

npx @daominhhiep/codex-kit init
npx @daominhhiep/codex-kit install
npx @daominhhiep/codex-kit install --target plugin

npx @daominhhiep/codex-kit setup-codex
npx @daominhhiep/codex-kit sync-codex
The local marketplace appears in the Plugin Directory after the project scaffold and workspace plugin are installed.

Plugin Install Steps

  • Run npx @daominhhiep/codex-kit init or npx @daominhhiep/codex-kit install if the repository does not have the Codex Kit scaffold yet.
  • Run npx @daominhhiep/codex-kit install --target plugin to add the workspace plugin files and marketplace entry.
  • Restart Codex or reopen the workspace if the local marketplace is not visible yet.
  • Open Plugins in the left sidebar.
  • Switch the marketplace selector to Codex Kit Local.
  • Find Codex Kit under Developer Tools and click + to install it.
  • Start a new thread and invoke it with @Codex Kit.

Install Only The Project Skill Bundle

Run install --target skills when you only want the shipped project skills and shared skill assets copied into the current repository.

This installs the project-local skill bundle under .agents/skills and .agents/.shared without touching local Codex.

npx @daominhhiep/codex-kit install --target skills

npx @daominhhiep/codex-kit sync --target skills

Install The MCP Bundle

Codex stores MCP configuration in config.toml, either in project scope at .codex/config.toml or in local scope at ${CODEX_HOME:-~/.codex}/config.toml.

Codex Kit ships a default MCP bundle based on the current project scaffold, including context7 and a commented mysql example using @benborla29/mcp-server-mysql.

npx @daominhhiep/codex-kit install --target mcp

npx @daominhhiep/codex-kit install --target mcp --scope local
npx @daominhhiep/codex-kit sync --target mcp
npx @daominhhiep/codex-kit list --target mcp

Install The Kit Skills Into Local Codex

Use install --target skills --scope local when you want the shipped Codex Kit skill catalog available in local Codex outside a single project workspace.

By default, Codex Kit installs the skills into ${CODEX_HOME:-~/.codex}/skills. Use --codex-home to override that location.

npx @daominhhiep/codex-kit install --target skills --scope local

npx @daominhhiep/codex-kit install --target skills --scope local --codex-home ~/.codex
Use install --target skills --scope local when you want the Codex Kit skill catalog available in local Codex outside a single workspace.

Local Skill Install Permission Prompt

Installing into local Codex may require approval because the CLI writes into ${CODEX_HOME:-~/.codex}/skills, which is typically outside the current workspace.

This is especially relevant when you install a specific skill with --skills from inside a Codex thread.

A targeted install such as install --target skills --scope local --skills frontend-design can trigger a local permission prompt before Codex writes into the local skills directory.

Sync Or Remove Local Skills

Use sync --target skills --scope local to overwrite the local Codex copy with the current shipped version from Codex Kit.

Use --skills when you want to install, sync, or remove only specific skill folders instead of the full catalog.

remove --target skills --scope local requires --skills so the CLI does not remove the full local skill catalog by accident.

npx @daominhhiep/codex-kit sync --target skills --scope local

npx @daominhhiep/codex-kit install --target skills --scope local --skills clean-code,planning
npx @daominhhiep/codex-kit sync --target skills --scope local --skills clean-code,planning
npx @daominhhiep/codex-kit remove --target skills --scope local --skills clean-code,planning

Discover Available Skills

Use list --target skills to browse the full shipped catalog grouped by category.

Use list --target skills --query <text> to find the right skill by domain, behavior, or keyword.

Use list --target skills --scope local to compare what is already installed in local Codex.

The bundled plugin can also map natural requests such as cài skill frontend or liệt kê skills debug to the right Codex Kit commands.

npx @daominhhiep/codex-kit list --target skills

npx @daominhhiep/codex-kit list --target skills --query frontend
npx @daominhhiep/codex-kit list --target skills --scope local
PreviousInstallationNextAgents