Documentation entry point

Read the Docs

Codex MemKit v2.6.10 — current guide, daily workflow, and guardrails.

This page is based on GUIDE.md (v2.6.10). It explains what lives at repo root, what stays in .codex/, how to run start, and how Spec YOLO can generate spec/plan/tasks from a single MASTER_SPEC.md with no Q&A.

Overview What’s new What goes where Install Spec YOLO Daily use Locks Git checkpoints Assumptions References

Docs at a glance

Root canon: AGENTS.md + brief.md + CURRENT.md.
Guide: GUIDE.md (single current guide).
Memory: Repo-local .codex/ (docs + scripts only).
Spec YOLO: Optional MASTER_SPEC.md → spec/plan/tasks.
Artifacts: Screenshots/build outputs stay untracked.

Overview

Codex Memory Kit is a repo-local memory bank + workflow contract that makes Codex predictable across sessions. It standardizes startup, keeps history append-only, and supports optional Spec Kit integration alongside Spec YOLO.

Root canon

AGENTS.md, brief.md, CURRENT.md, and GUIDE.md live at repo root.

Repo-local memory

.codex/ stores memory/meta/state, never application code.

Guardrails

Mutation guards, component locks, and optional git checkpoints reduce drift.

What’s new in v2.6.10

One “current guide” flow: CURRENT.md points to GUIDE.md (single source).

Current guide

CURRENT.md + GUIDE.md reduce doc drift across versions.

Spec YOLO

One file in, spec/plan/tasks out. No interactive prompts.

Locks + checkpoints

Component locks and optional git checkpoints add friction in the right places.

What goes where (critical)

The control plane is root-only, and artifacts never get tracked.

Repo root (tracked)

AGENTS.md — contract Codex must follow.
brief.md — canonical brief when Spec Kit is absent.
CURRENT.md — canonical pointer.
GUIDE.md — full current guide (v2.6.10).
MASTER_SPEC.md — Spec YOLO input (recommended).
.gitignore — must include the kit block.

.codex/ (tracked docs + scripts)

.codex/meta/ — policies + flags.
.codex/memory/ — decision log + capability index.
.codex/state/ — run reports + task history.
.codex/scripts/ — helper scripts.

.codex/artifacts/ (NOT tracked)

Screenshots, images, and build artifacts. Use .keep only for folders.

Install

Minimum steps to set up a new repo.

Copy .codex/ into repo root.
Add root AGENTS.md, brief.md, CURRENT.md, and GUIDE.md.
Ensure .gitignore contains the kit block.
Commit the setup.

Spec YOLO (one file → spec/plan/tasks)

Use a single root file for fast spec generation with no Q&A.

Steps

Fill out MASTER_SPEC.md.
In Codex, run spec (or .codex/scripts/spec-from-master.sh).

Outputs

.specify/specs/<project-slug>/spec.md
.specify/specs/<project-slug>/plan.md
.specify/specs/<project-slug>/tasks.md

Daily use

What the contract expects Codex to do every time.

Run start to bootstrap and enforce git hygiene.
Run .codex/scripts/codex-lint.sh (use --fix when needed).
Run .codex/scripts/refresh-skills.sh to regenerate capabilities.
Keep .codex/state/history.md append-only.

Component locks

Lock completed targets so they don’t drift when you move on.

Lock: .codex/scripts/lock-component.sh SOFT <path-or-glob> "note"
Check: .codex/scripts/is-locked.sh <path>
Unlock: .codex/scripts/unlock-component.sh --i-acknowledge <LOCK_ID>

Git checkpoints

Optional “autosave for vibe coding”: commit (and optionally push) with guardrails.

Enable autosave: .codex/meta/git-autosave.enabled.flag = ENABLED
Enable autopush: .codex/meta/git-autopush.enabled.flag = ENABLED
Branch-per-session: .codex/meta/git-branch-per-session.enabled.flag = ENABLED
Force checkpoint: .codex/scripts/git-checkpoint.sh --force "checkpoint: …"