CodexQB logo

CodexQB

CodexQB is a Codex plugin for evidence-backed repo comprehension, planning, QA audit, and gated implementation handoffs.

GitHub

What is it?

What it is

CodexQB is a Codex plugin that transforms a project repository into a durable, evidence-backed planning package. It generates structured planning documents, audits, and implementation contracts to ensure secure, adaptable, and reviewable project planning.

Why it exists

CodexQB exists to provide a vibecoding-first planning framework that prioritizes evidence-backed decisions, security, and adaptability. It ensures planning is reviewable, source-bound, and ready for small verified execution slices while maintaining strict validation and privacy controls.

Who should use it

Software, AI, infrastructure, security, and automation project teams that require evidence‑backed, reviewable, and adaptive planning with small verified execution slices, and who are comfortable using Codex plugins and detailed planning artifacts.

Who should avoid it

Teams or individuals looking for quick, hands‑on implementation without extensive planning, or those managing very small or trivial projects where the overhead of CodexQB’s planning workflow outweighs benefits.

How it works

A quick walkthrough in plain English

How CodexQB works

Step 1 of 3

You interact with it

Open CodexQB, send a request, or connect it to your stack.

Features

Repo‑aware intake that auto‑suggests project metadata
Durable planning artifacts written under Planner‑docs/
Automated Autopsy, Ontology, and Comprehension reports
Adaptive phase decomposition with deferred roadmap cards
Implementation‑ready sub‑plans with machine‑readable contracts
Structured command and risk contracts with safe‑command validation
QA audit that checks coverage, structure, governance, and readiness
Deterministic Goal and Apply specifications with source binding
Gated execution handoff that prints Goal prompts only after audit passes
Artifact‑based Apply runs with strict validation and token usage tracking
Vibecoding‑first behavior that prioritizes small reversible slices
Safety model that prohibits destructive actions, secret leakage, and unapproved changes
Validator scripts for all planning stages
Release validation pipeline with privacy scans and sanitized exports

Advantages

  • Evidence‑backed planning documents that survive context changes
  • Reviewable and auditable implementation contracts
  • Built‑in safety checks preventing accidental code changes
  • Deterministic artifacts enable reproducible runs and audits
  • Clear token usage and budget reporting for cost control
  • Privacy‑aware release validation protects sensitive data
  • Modular sub‑plans allow incremental implementation
  • QA audit gates reduce risk before code changes
  • Compatibility with Codex plugin ecosystem
  • Automated validation reduces manual oversight

Disadvantages

  • Complex workflow may be overkill for small projects
  • Requires Codex plugin installation and familiarity
  • Learning curve for understanding Planner‑docs conventions
  • Performance overhead from multiple validation steps
  • Dependency on Codex environment and API limits
  • Potentially verbose documentation and artifacts
  • Requires careful configuration to avoid false positives in audits

Installation

FAQ

How do I install CodexQB as a plugin in Codex?

Add the repository as a Codex plugin marketplace with `codex plugin marketplace add alicankiraz1/CodexQB --ref main`, then install the `codexqb` skill using `codex plugin add codexqb@codexqb`.

What does 'vibecoding-first' mean in CodexQB?

It prioritizes planning over premature implementation, focusing on small reversible slices, validation signals, and human review checkpoints while maintaining safety and source-bound execution.

How does CodexQB validate planning artifacts?

It uses a dependency-free validator that checks required sections, schema frontmatter, implementation contracts, security reviews, and Step 4 readiness. Manual validation runs via `validate_planner_docs.py` or `make check`.

How does CodexQB handle existing projects?

It generates an `Autopsy.md` report and may create `Project-Ontology.md` and `Project-Comprehension.md` to capture evidence confidence, architecture reflections, and open validation probes.

What role do subagents play in CodexQB?

Subagents handle specialized tasks like repo exploration, security reviews, or implementation phases, managed through structured dispatch packets and role-specific contracts.

How are releases sanitized and privacy-checked?

Sanitized releases use `make export-sanitized` to exclude sensitive paths, track provenance, and scan for local user paths or UUID-like identifiers. Privacy scans run via `make check-public-privacy`.

Loading documentation…
View on GitHub

Featured in Videos

YouTube tutorials and walkthroughs for CodexQB

Alternatives

Similar projects ranked by category, topics, and text overlap.

Compare
CodexQB | MushyBook