omni-coder-kit

v3.0.0

Published

a month ago

CLI inject mindset + SDLC workflow + skills into AI coding agents — Claude Code, Codex CLI, Cursor, Windsurf, Antigravity

0High
0Medium
0Low

tav99

ai cli claude claude-code codex cursor windsurf antigravity agents-md sdlc workflow prompt-engineering developer-tools skills-sh karpathy

Omni-Coder Kit

Omni-Coder Kit là một bộ công cụ CLI giúp inject mindset phát triển phần mềm chuẩn mực (Karpathy Mindset), SDLC workflows và các kỹ năng chuyên sâu vào AI coding agents (Claude Code, Antigravity CLI, Cursor, Windsurf, Codex, Gemini CLI...). Công cụ này định hướng AI hoạt động với kỷ luật của một Senior Engineer, tuân thủ quy trình SDLC nghiêm ngặt và hạn chế tối đa lỗi ảo tưởng (hallucination).

Trong phiên bản mới nhất (v3.0.0), Omni-Coder Kit hoạt động như một Agent Harness & Loop Runtime — tự lái vòng lặp SDLC: gọi LLM → thực thi quality gates (lint, build, test, security) → tự động sửa lỗi (fix loop) → tự động nghiệm thu (acceptance loop).

📦 Cài đặt & Khởi tạo nhanh

Yêu cầu Node.js >= 16.0.0.

Cài đặt toàn cục (global):
```
npm install -g omni-coder-kit
```
Khởi tạo trong dự án của bạn:
```
cd my-project
omni init
```
(Hệ thống sẽ tự động nhận diện DNA dự án như ngôn ngữ, UI/Backend và thiết lập cấu hình tích hợp tương ứng cho các IDE/Agent trong máy bạn)
Trong omni init bạn sẽ được hỏi ẩn hay hiện các file agent rules (AGENTS.md, CLAUDE.md, IDE dirs…) trên git:
- Hiện (mặc định khuyến nghị): commit được — share rules giữa máy/team.
- Ẩn: thêm block vào .gitignore — repo “sạch” dấu vết AI tooling. Đánh đổi: clone máy khác sẽ không có rules → cần omni init lại (và cấu hình rules lại).
Đổi sau init bằng CLI:
```
omni agent-files status   # visible | hidden
omni agent-files hide     # ẩn qua .gitignore + cảnh báo trade-off
omni agent-files show     # gỡ block ẩn (không xoá file local)
```

🚀 Hai cách sử dụng chính

Omni-Coder Kit hỗ trợ 2 cách tiếp cận linh hoạt tùy theo thói quen lập trình của bạn:

Cách 1: Chế độ tương tác trong Chat (`>om-*`) — Dành cho AI IDE

Sử dụng trực tiếp trong khung chat của các AI IDE (Cursor, Windsurf, Claude Code, Antigravity, Gemini CLI) bằng các câu lệnh siêu ngắn với tiền tố >om- (hoặc /om- trên Claude Code / Antigravity).

AI sẽ tự động đọc hướng dẫn trong thư mục .omni/workflows/ hoặc .agents/workflows/ để tuân thủ quy trình thiết kế, lập kế hoạch, code và test.

1. Lập trình tự động trọn gói (One-shot)

Gõ lệnh này trong chat để AI tự đi qua toàn bộ quy trình SDLC (Think → Skill → Plan → Cook → Check → Doc) chỉ với một yêu cầu:

>om-go Xây dựng trang Landing Page giới thiệu dịch vụ bằng HTML/CSS sạch

2. Lập trình từng bước (Tự kiểm soát)

Nếu bạn muốn tự kiểm soát từng giai đoạn, hãy chat với AI theo trình tự:

Tư vấn & Thiết kế: >om-think Xây dựng tính năng đăng nhập (AI phỏng vấn & xuất design-spec.md)
Cài kỹ năng: >om-skill (AI tự tìm và cài skill phù hợp cho stack)
Lập kế hoạch: >om-plan (AI phân tách task chi tiết trong todo.md)
Lập trình: >om-cook (AI viết code surgical & tự động chạy 3 Quality Cycles)
Kiểm định QA: >om-check (AI tự chạy linter, build, và test P0-P5)
Sửa lỗi: >om-fix (AI phân tích nguyên nhân & sửa lỗi khoanh vùng)
Nghiệm thu: >om-pass (AI chấm sản phẩm vs checklist yêu cầu)
Tài liệu: >om-doc (AI cập nhật README, API docs bằng tiếng Việt)
Đóng gói Release: >om-ship (AI làm sạch code, tạo changelog & version)

Cách 2: Chế độ tự động hoàn toàn (`omni run`) — Dành cho Terminal

Không cần mở khung chat IDE, bạn chỉ cần ra lệnh trên terminal của mình. Bộ điều phối (Orchestrator Harness) của Omni sẽ tự khởi chạy tác vụ và "lái" agent thực hiện từ đầu đến cuối một cách tự động.

1. Chạy tự động từ file đặc tả (Spec) của khách hàng

Nếu bạn có một file mô tả yêu cầu (spec.md), hãy để Omni tự đọc, tự phân tích thành checklist nghiệm thu (requirements.md), tự viết code, tự chạy test và sửa lỗi cho đến khi đạt 100% yêu cầu:

omni run --spec spec.md

2. Các lệnh điều khiển hữu ích trên Terminal:

Chạy tiếp tục: omni run --resume (Nếu phiên chạy bị tạm dừng hoặc lỗi, chạy lệnh này để tiếp tục từ vị trí cũ mà không tốn lại token từ đầu).
Chạy nháp không sửa code: omni run --dry-run (In ra kế hoạch hành động chi tiết để bạn kiểm tra trước).
Chạy kiểm định chất lượng độc lập: omni run gate (Chạy toàn bộ pipeline kiểm thử P0-P5: Security → Lint → Build → Test → Content).
Xem nhật ký sự kiện: omni run log (In event log chi tiết từ .omni/run/events.ndjson).

🛠️ Tra cứu nhanh danh sách lệnh

1. Lệnh trong khung Chat (`>om-` / `/om-`)

Khi chat với AI trong IDE, hãy gõ các lệnh sau ở đầu câu để định hướng hành vi của AI:

2. Lệnh trong CLI Terminal (`omni <nhóm>`)

CLI gọn nhẹ với các nhóm lệnh điều khiển chính:

Migration từ 2.x → 3.0 (breaking)

Các hidden aliases CLI đã bị gỡ. Dùng lệnh canonical:

Chat commands >om-* không đổi. Chi tiết release: CHANGELOG.md, checklist ship: RELEASE.md.

⚙️ Cơ chế tự động & Chế độ vận hành (Run Mode)

Omni-Coder Kit được thiết kế để cân bằng giữa sự tự động hóa tuyệt đối và sự kiểm soát an toàn của người dùng:

Vòng lặp 3 Quality Cycles (cook → check → fix): Trong quá trình >om-cook, hệ thống tự động chia công việc thành 3 đợt kiểm thử chất lượng. Sau mỗi checkpoint task, agent sẽ tự động thực thi >om-check. Nếu phát hiện lỗi, agent tự chuyển sang >om-fix để sửa và kiểm thử lại trước khi làm task tiếp theo.
Chế độ AUTO vs MANUAL:
- Chế độ AUTO: Ngay sau khi phần hỏi-đáp của >om-think kết thúc, hệ thống TỰ ĐỘNG nối chuỗi: >om-skill → >om-plan → >om-cook mà không cần người dùng can thiệp giữa các bước.
- Chế độ MANUAL: Người dùng tự chủ động gõ từng lệnh >om- theo mong muốn.
Chế độ Nghiệm thu (Acceptance Loop): Nếu dự án có file requirements.md, sau khi >om-check hoàn thành, hệ thống sẽ chạy vòng lặp nghiệm thu >om-pass để chấm điểm từng mục yêu cầu (đạt 100% met mới cho phép >om-ship).

📂 Cấu trúc thư mục của Omni trong dự án

Sau khi chạy omni init, thư mục dự án của bạn sẽ xuất hiện thêm các cấu hình quản lý:

your-project/
├── AGENTS.md (hoặc CLAUDE.md, .cursor/rules/, .windsurf/rules/...) # File quy tắc IDE siêu nhẹ
├── .agents/                        # Bộ quy tắc, workflows và skills dùng chung cho các agent
│   ├── rules/                      # Quy tắc lõi (core-mindset, workflow-commands, yolo-guardrails...)
│   ├── skills/                     # Các bộ kỹ năng chuyên sâu (TDD, debugging, visual UI...)
│   └── workflows/                  # Chỉ dẫn luồng thực thi SDLC
└── .omni/
    ├── manifest.json               # Trạng thái IDE, skill đã cài, agentFilesVisibility
    ├── run/                        # [Harness] Log hoạt động & state phiên chạy tự động
    │   ├── state.json              # Trạng thái hiện tại (để resume)
    │   └── events.ndjson           # Lịch sử sự kiện thực thi realtime
    ├── workflows/                  # File chỉ dẫn luồng SDLC nạp vào AI khi chat >om-
    ├── sdlc/                       # Output quá trình phát triển (todo.md, design-spec.md...)
    └── knowledge/                  # Bản đồ codebase (project-map.md) & tri thức (knowledge-base.md)

Ẩn file agent khỏi git (tuỳ chọn): nếu chọn Ẩn lúc init hoặc chạy omni agent-files hide, Omni thêm block có marker vào .gitignore (root config + IDE dirs như .claude/, .agents/, …). File vẫn tồn tại local — chỉ không commit. omni agent-files show gỡ block đó. File đã track trước đó cần bạn tự git rm --cached nếu muốn untrack.

💖 Nguồn cảm hứng

Dự án được phát triển và tối ưu dựa trên ý tưởng từ:

📄 Giấy phép

Mã nguồn được phân phối dưới giấy phép ISC. Phát triển và duy trì bởi TAV ([email protected]).

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme