VibeFlow Documentation

Tài liệu được tổ chức theo Diátaxis — 4 nhóm theo nhu cầu người đọc.

📖 Tutorials — học theo bước

  • User Guide — Verifiable end-to-end walkthrough: install, mental model, web UI, CLI, and troubleshooting.

🔧 How-to Guides — giải quyết task

  • Workflow — End-to-end task flow: intake questions, context normalization, and output report.
  • Deployment — How to deploy VibeFlow to git and npm with versioning and tarball verification.
  • Self-Hosted Runner — Set up and manage a self-hosted GitHub Actions runner on macOS.
  • Hooks and Guardrails — Configure safety hooks across Claude Code, Codex, and Copilot.

📚 Reference — tra cứu

  • Command Reference — Complete reference of all shipped vf CLI commands and their flags.
  • npm CLI Design — CLI design: startup flow, commands, package layout, and dependency policy.
  • Generated Files — All files the orchestrator may generate in a target repository.
  • Coverage — CLI flags reference, coverage enforcement rules, and anti-patterns suite.
  • Coordination Template — Copy-pasteable template for coordinating sub-agents.
  • Master Spec — Master specification: design principles, engine support, and naming decisions.

💡 Explanation — hiểu khái niệm

  • Architecture — High-level architecture: four main layers from npm CLI launcher to tool adapters.
  • Security Model — Safety posture, permission classes, protected paths, secrets handling, and audit log.
  • Agent Orchestration Policy — Confidence thresholds, debate rules, anti-hallucination, and verification policy.
  • Work-Unit Orchestration — How tasks are decomposed into scoped, file-backed work units with quality gates.
  • Skill Discovery and Evolution — External discovery and internal evolution of skills from real project execution.
  • Skill Providers — Provider-based discovery layer: Context7, Vercel find-skills, npm, and trust model.
  • Skills System — Anthropic-style skill standard: format, metadata, categories, and registry priority.
  • Tool Adapters — How canonical context is translated into engine-specific files for Claude, Codex, and Copilot.
  • Web UI Design — Design specification for the web UI: screens, UX principles, and real-time updates.

Related: Diátaxis Framework · VibeFlow on GitHub Edit this page on GitHub