Getting Started

Installation

Install the CLI and scaffold a repository that is ready for Codex.

Codex Kit is published as @daominhhiep/codex-kit.

You can run it with npx, install it globally, or point it at a target directory when you want to scaffold into a new folder.

Quick Install

npx @daominhhiep/codex-kit init

npm install -g @daominhhiep/codex-kit
codex-kit init

Initialize Into A Target Directory

npx @daominhhiep/codex-kit init --path ./my-project

Scaffold Layout

AGENTS.md
ARCHITECTURE.md
AGENT_FLOW.md
.agents/
  skills/
  .shared/
  workflows/
.codex/
  config.toml
  agents/
codex/
  rules/
    default.rules
.codex-kit/
  manifest.json

Codex Rules

The scaffold also includes codex/rules/default.rules, a minimal execution-policy template based on the official Codex rules format.

It prompts before dependency installs, git push, and Codex Kit commands that write into local Codex with --scope local.

Keep behavioral guidance in AGENTS.md, skills, and workflows. Use codex/rules/default.rules only for command approval policy.

codex execpolicy check --pretty \
  --rules ./codex/rules/default.rules \
  -- git push origin main

Notes

Use --force only when you intentionally want to overwrite managed files.
Use --dry-run to inspect changes before writing scaffold files.
Use status and update after installation to keep managed files aligned with the current template version.
Edit codex/rules/default.rules if your team wants a different approval posture.
Read Local Codex Setup next if you want the plugin or skill catalog installed into Codex.