explaingit

alicankiraz1/codexqb

Analysis updated 2026-05-18

28PythonAudience · developerComplexity · 3/5LicenseSetup · easy

TLDR

A Codex plugin that adds a structured, gated project planning workflow, producing reviewable planning documents before any code gets written.

Mindmap

mindmap
  root((CodexQB))
    What It Does
      Structured planning workflow
      Gated handoff to coding
    Tech Stack
      Python
      Codex
      GitHub Actions
    Use Cases
      Project planning docs
      Quality audits
    Audience
      Developers
      Codex users

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Generate a structured planning document for a new or existing software project before writing code.

USE CASE 2

Break a main plan into ordered phase folders with detailed sub-plans.

USE CASE 3

Run an automated quality audit on planning documents before handing off to implementation.

USE CASE 4

Produce a copy-pasteable prompt to start a separate Codex implementation session.

What is it built with?

PythonCodexGitHub ActionsMakefile

How does it compare?

alicankiraz1/codexqbcrain99/worldcut-2026errnex/auto-clip
Stars282828
LanguagePythonPythonPython
Setup difficultyeasymoderatemoderate
Complexity3/53/53/5
Audiencedevelopergeneralvibe coder

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

Installs via Codex's plugin marketplace with two commands from the README.

MIT license: use, modify, and distribute freely, including commercially, as long as you keep the copyright notice.

In plain English

CodexQB is a plugin for Codex, an AI coding environment, that adds a structured project planning workflow as a reusable skill called $codexqb. The idea is to give software projects a defined planning phase before any code gets written or changed, with each step producing documentation that persists in the repository and can be reviewed like normal project files. The workflow has four main steps. In the first step, CodexQB reads the current repository, then asks four questions: the project name, intent, target end state, and known constraints. For existing projects it reads the repo first and proposes defaults based on what it finds. The output is a main planning document saved under a Planner-docs folder. For projects that already have code, an optional autopsy step produces a separate report covering existing modules, placeholder items, technical debt, integration gaps, and readiness risks. In the second step, the main plan gets broken down into ordered phase folders, each with detailed sub-plan files. The third step is a quality audit that checks coverage, naming, ordering, structure, and implementation readiness without modifying any files. Only after the audit passes does CodexQB produce the fourth step: a text prompt you copy into a new Codex thread to begin actual implementation. This handoff is gated so planning and building stay in separate sessions, keeping the user in control of when work starts. CodexQB does not implement product features, run destructive commands, commit code, or write credentials into planning documents. It also includes a validator script and a Makefile target called make check for confirming that planning documents meet structural requirements before the implementation handoff is allowed. The plugin installs via Codex's repository marketplace with two commands listed in the README. It is released under the MIT license and includes GitHub Actions that run the same validation checks automatically on pushes to the main branch.

Copy-paste prompts

Prompt 1
Run $codexqb on this repository and generate a planning document for adding a new feature.
Prompt 2
Explain the four steps of the CodexQB workflow and what each one produces.
Prompt 3
What does the CodexQB quality audit check before allowing implementation to begin?
Prompt 4
Show me the make check command this project uses to validate planning documents.

Frequently asked questions

What is codexqb?

A Codex plugin that adds a structured, gated project planning workflow, producing reviewable planning documents before any code gets written.

What language is codexqb written in?

Mainly Python. The stack also includes Python, Codex, GitHub Actions.

What license does codexqb use?

MIT license: use, modify, and distribute freely, including commercially, as long as you keep the copyright notice.

How hard is codexqb to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is codexqb for?

Mainly developer.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.