precheck-cli
v0.1.4
Published
AI Development Pre-collaboration Risk Warning System - detect team conflicts before coding starts
Maintainers
Readme
Precheck CLI
AI Development Pre-collaboration Risk Warning System
Detect file/function/field-level conflicts between team members before coding starts.
Installation
Global CLI (Recommended)
npm install -g precheck-cliProject-local
npm install precheck-cli
# 使用 npx 运行
npx precheck --versionAI Coding Platform Integration
precheck-cli 为 OpenCode、Claude Code 等 AI 工具生成集成文件(skill、command),让 AI 自动检测协作冲突。
OpenCode:
# 1. 全局安装 precheck
npm install -g precheck-cli
# 2. 在项目目录初始化 precheck 集成
precheck init opencode
# 生成: .opencode/skills/precheck/SKILL.md
# .opencode/command/precheck.md
# 3. 重启 OpenCodeClaude Code:
# 1. 全局安装 precheck
npm install -g precheck-cli
# 2. 在项目目录初始化
precheck init claude-code
# 生成: .claude/commands/precheck.mdQuick Start
# 1. Initialize precheck in your project
precheck init opencode
# 2. Propose a contract before coding
precheck propose -o alice -t "Implement order refund" -b feature/refund -m src/services/refund.ts
# 3. Scan for conflicts
precheck scan rough
# 4. Resolve conflicts if found
precheck resolve -i c1 c2 -s merge
# 5. Validate after coding
precheck validate --stagedCommands
| Command | Description |
|---------|-------------|
| precheck init <platforms> | Generate integration files for AI coding platforms |
| precheck propose -o -t -b -m | Create a new contract for your task |
| precheck scan rough | Quick scan for conflicts |
| precheck scan fine --plan <path> | Detailed scan with plan file |
| precheck resolve -i <ids> -s <strategy> | Resolve contract conflicts |
| precheck amend -i <id> [-t] [-m] | Amend an existing contract |
| precheck validate [text] | Validate a requirement or merge readiness |
| precheck validate --staged | Validate actual changes against contracts |
| precheck status | Show current contract status |
| precheck contract list | List all contracts |
| precheck contract repair | Repair corrupted contracts |
| precheck contract archive -i <id> | Archive a completed contract |
Workflow
┌─────────────────────────────────────┐
│ 1. Propose │
│ precheck propose -o <owner> │
│ -t "<task>" │
│ -b <branch> │
│ -m <files> │
│ ↓ │
│ 2. Scan │
│ precheck scan rough │
│ ↓ │
│ 3. Resolve (if conflicts) │
│ precheck resolve -i <ids> │
│ -s merge │
│ ↓ │
│ 4. Code │
│ ... write code ... │
│ ↓ │
│ 5. Validate │
│ precheck validate --staged │
│ ↓ │
│ 6. Archive │
│ precheck contract archive │
└─────────────────────────────────────┘Exit Codes
| Code | Meaning | |------|---------| | 0 | OK | | 1 | Conflict detected | | 2 | High impact | | 3 | Quality fail | | 4 | Contract expired | | 5 | Validation fail | | 10 | Invalid args | | 11 | Config error | | 12 | Git error | | 13 | Parse error | | 20 | IO error | | 21 | Lock error | | 30 | Timeout | | 50 | Internal error |
