Skip to content

Repository files navigation

VibeCoding Start cover

Language / 语言
English  |  中文

VibeCoding Start

Plugin Validation Standards Audit License: MIT

Stop vibe coding from turning into unmaintainable AI-generated messes.

VibeCoding Start is a skill-only Codex Plugin that adds a lightweight engineering system from the first project session:

  • PRD before code
  • Search before build
  • Indexed project knowledge
  • Independent review
  • Adversarial verification
  • Human-readable acceptance
  • Rollback-aware release
  • Local-first raw project memory

Why it exists

Without an engineering workflow, an AI-built project often grows like this:

Idea → Prompt → Code → More Code → Context Lost → Unmaintainable mess

With VibeCoding Start:

Idea → PRODUCT → PRD → ACCEPTANCE → Reuse → Plan
→ Build → Review → Verify → Accept → Release → Observe

The project always has a small knowledge skeleton. Small projects keep it short; larger projects earn deeper decisions, plans, testing, operations, release, and incident records.

Documentation

What it includes

This repository is the single public source of truth for the vibecoding-start Plugin:

plugins/vibecoding-start/
├── .codex-plugin/plugin.json
└── skills/
    ├── vibecoding-start/
    │   ├── SKILL.md
    │   ├── agents/openai.yaml
    │   └── (main workflow)
    └── vibecoding-project-knowledge/
        ├── SKILL.md
        ├── agents/openai.yaml
        ├── references/ (including standard-v1.3.md)
        ├── templates/
        └── scripts/

The companion Skill manages INIT, UPDATE, and AUDIT for project knowledge. It is explicit-only in the UI so it does not compete with the main workflow's implicit invocation.

Installation

Add this repository as a Codex plugin marketplace, then install the Plugin. The pinned release command below uses v0.1.1; use main only when you intentionally want the latest development state.

codex plugin marketplace add https://github.com/kktbur/VibeCoding-Start --ref v0.1.1
codex plugin add vibecoding-start@kktbur

For the latest development state:

codex plugin marketplace add https://github.com/kktbur/VibeCoding-Start --ref main
codex plugin add vibecoding-start@kktbur

For a local checkout:

codex plugin marketplace add ./VibeCoding-Start
codex plugin add vibecoding-start@kktbur

Start a new Codex session after installation, then invoke:

$vibecoding-start
I want to build a small local file-renaming tool.

Troubleshooting

  • Restart Codex in a new session if $vibecoding-start is unknown after installation.
  • Confirm the marketplace name in .agents/plugins/marketplace.json matches the @name in codex plugin add.
  • Run codex plugin marketplace list to confirm that the repository source is configured.
  • This package does not install a memory database, CI system, or hosted observability backend.

Quick start behavior

For a new project, the workflow establishes:

AGENTS.md
docs/
├── INDEX.md
├── PRODUCT.md
├── PRD.md
├── ACCEPTANCE.md
├── CURRENT.md
└── CODEMAP.md

It then applies the risk-scaled G0-G9 gates. The first implementation question for a general capability is whether an existing project capability, standard library, official tool, mature package, adapter, or composition can be used. Custom implementation is the last option, not the default.

Project memory and privacy

Raw sessions, command output, failed attempts, investigations, and test artifacts stay in local .project-memory/ and are ignored by Git by default. Durable facts go to docs/; reusable public examples go to docs/examples/ only after redaction and human review. This package does not create a memory database, vector database, search engine, testing framework, deployment framework, CI service, or observability backend.

Compatibility and maintenance

The package uses the standard Codex Skill layout (SKILL.md, optional agents/openai.yaml, and focused references) inside a .codex-plugin/plugin.json distribution unit. When the standard changes, update the active v1.3 reference and workflow, run the local audits and fixture tests, review the diff independently, and record the release/rollback state before publishing.

License

MIT. See LICENSE.


VibeCoding Start(中文)

Language / 语言
English  |  中文

不要让 Vibe Coding 最终变成难以维护的 AI 生成代码堆。

VibeCoding Start 是一个仅由 Skills 组成的 Codex Plugin,从项目第一次会话开始提供轻量级工程系统:

  • 先写 PRD,再写代码
  • 先搜索,再构建
  • 建立索引化项目知识
  • 独立评审
  • 面向反例的验证
  • 人类可读的验收
  • 具备回滚意识的发布
  • 本地优先的原始项目记忆

为什么需要它

没有工程工作流时,一个 AI 构建的项目通常会这样增长:

想法 → Prompt → 代码 → 更多代码 → 上下文丢失 → 难以维护的混乱项目

使用 VibeCoding Start 后:

想法 → PRODUCT → PRD → ACCEPTANCE → Reuse → Plan
→ Build → Review → Verify → Accept → Release → Observe

项目始终会有一套小型知识骨架。小项目保持简短;只有当项目复杂度确实需要时,才增加更深入的决策、计划、测试、运维、发布和事故记录。

文档

包含内容

本仓库是 vibecoding-start Plugin 的唯一公开事实来源:

plugins/vibecoding-start/
├── .codex-plugin/plugin.json
└── skills/
    ├── vibecoding-start/
    │   ├── SKILL.md
    │   ├── agents/openai.yaml
    │   └──(主工作流)
    └── vibecoding-project-knowledge/
        ├── SKILL.md
        ├── agents/openai.yaml
        ├── references/(包括 standard-v1.3.md)
        ├── templates/
        └── scripts/

配套 Skill 负责项目知识的 INITUPDATEAUDIT。在 UI 中它只支持显式调用,因此不会与主工作流的隐式调用相互竞争。

安装

先把这个仓库添加为 Codex Plugin marketplace,再安装 Plugin。下面的固定版本命令使用 v0.1.1;只有在你明确需要最新开发状态时,才使用 main

codex plugin marketplace add https://github.com/kktbur/VibeCoding-Start --ref v0.1.1
codex plugin add vibecoding-start@kktbur

如果需要最新开发状态:

codex plugin marketplace add https://github.com/kktbur/VibeCoding-Start --ref main
codex plugin add vibecoding-start@kktbur

如果使用本地 checkout:

codex plugin marketplace add ./VibeCoding-Start
codex plugin add vibecoding-start@kktbur

安装后请启动一个新的 Codex session,然后调用:

$vibecoding-start
I want to build a small local file-renaming tool.

故障排查

  • 安装后如果 $vibecoding-start 未知,请在新 session 中重新启动 Codex。
  • 确认 .agents/plugins/marketplace.json 中的 marketplace name 与 codex plugin add 中的 @name 一致。
  • 运行 codex plugin marketplace list,确认仓库来源已经配置。
  • 这个 package 不会安装 memory database、CI system 或 hosted observability backend。

快速开始时的行为

对于新项目,工作流会建立:

AGENTS.md
docs/
├── INDEX.md
├── PRODUCT.md
├── PRD.md
├── ACCEPTANCE.md
├── CURRENT.md
└── CODEMAP.md

随后它会应用按风险缩放的 G0-G9 gates。对于通用能力,第一次实现问题应该是:是否可以使用现有项目能力、standard library、official tool、成熟 package、adapter 或 composition。自定义实现是最后选项,而不是默认选项。

项目记忆与隐私

原始 session、命令输出、失败尝试、调查记录和测试产物保存在本地 .project-memory/ 中,默认由 Git 忽略。稳定事实写入 docs/;可复用的公开示例只有在完成脱敏并经过人工审查后,才放入 docs/examples/。这个 package 不会创建 memory database、vector database、search engine、testing framework、deployment framework、CI service 或 observability backend。

兼容性与维护

这个 package 使用标准 Codex Skill layout(SKILL.md、可选的 agents/openai.yaml 和聚焦的 references),并通过 .codex-plugin/plugin.json 组成 distribution unit。标准发生变化时,应更新 active v1.3 reference 和 workflow,运行本地 audits 与 fixture tests,独立 review diff,并在发布前记录 release/rollback 状态。

License

MIT。参见 LICENSE

About

A Vibe Coding governance skill that keeps projects from turning into unmaintainable AI-generated messes by setting up clear docs, reusable project knowledge, quality gates, independent review, testing, observability, and rollback-ready workflows from day one.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages