flowmind 1.4.6 → 1.4.7

package/demo/DEMO.md

@@ -0,0 +1,263 @@
+<div align="center">
+
+# FlowMind Demo
+
+**How to Use FlowMind in Your Daily Work**
+
+[中文](DEMO_CN.md)
+
+</div>
+
+---
+
+![FlowMind terminal demo](flowmind-demo.gif)
+
+## Quick Start
+
+### Install
+
+```bash
+npm install -g flowmind
+```
+
+### Try Without Install
+
+```bash
+npx flowmind@latest skills
+npx flowmind@latest doctor
+```
+
+### Initialize
+
+```bash
+flowmind init
+```
+
+> One-time setup. Configure your resources, preferences, and output formats.
+
+---
+
+## Scenario 1: Online Issue Investigation
+
+**Before FlowMind (10+ steps):**
+```
+Login SLS → Query logs → Find traceId → Trace chain → Connect RDS → Query data → Locate code → Fix → Deploy → Write doc
+```
+
+**With FlowMind (1 command):**
+```bash
+flowmind "排查线上问题 traceId abc123"
+```
+
+FlowMind automatically: SLS query → Trace tracking → RDS data validation → Code location → Fix suggestion
+
+### Step by Step
+
+```bash
+# 1. Query logs with your preferred format
+flowmind "查询 traceId abc123 的日志，用顺序列表格式"
+
+# 2. FlowMind learns your preference
+# Next time, just:
+flowmind "查询 traceId def456 的日志"
+# → Automatically uses sequential list format
+```
+
+---
+
+## Scenario 2: Code Review
+
+### Set Your Standards (Once)
+
+```bash
+flowmind "代码审查先检查安全漏洞，再检查代码质量，最后检查性能"
+```
+
+### Review Any PR
+
+```bash
+flowmind "审查这个 PR"
+# → Security first → Quality check → Performance analysis
+```
+
+### Review Specific File
+
+```bash
+flowmind "审查 src/api/users.js 的安全漏洞"
+```
+
+---
+
+## Scenario 3: Data Validation
+
+### Validate Order Data
+
+```bash
+flowmind "验证订单表数据完整性"
+# → Referential integrity → Data types → Business logic → State machine
+```
+
+### Verify Calculations
+
+```bash
+flowmind "验证订单金额计算是否正确"
+```
+
+### Check Redis Cache
+
+```bash
+flowmind "验证缓存逻辑，检查 store:{storeId}:config 的结构"
+```
+
+---
+
+## Scenario 4: API Documentation
+
+### Generate from Code
+
+```bash
+flowmind "从代码注释生成 API 文档"
+```
+
+### Sync to YApi
+
+```bash
+flowmind "同步 OrderController 的接口到 YApi"
+```
+
+### Sync to Yuque
+
+```bash
+flowmind "同步 API 文档到语雀"
+```
+
+---
+
+## Scenario 5: Log Analysis
+
+### Trace Analysis
+
+```bash
+flowmind "查询 traceId abc123 的完整链路"
+```
+
+### Error Investigation
+
+```bash
+flowmind "查看最近1小时的错误日志"
+```
+
+### Performance Analysis
+
+```bash
+flowmind "分析 payment-service 接口耗时"
+```
+
+---
+
+## Scenario 6: Project Health Check
+
+```bash
+flowmind "审查项目整体状况"
+# → Dependencies → Security audit → Code complexity → Test coverage → Technical debt
+```
+
+### Security Audit
+
+```bash
+flowmind "进行安全审计"
+```
+
+---
+
+## Learning System
+
+### How It Works
+
+```bash
+# First time - teach FlowMind
+flowmind "查询日志用顺序列表格式"
+FlowMind: ✓ Learned
+
+# Next time - FlowMind remembers
+flowmind "查询 traceId abc123 的日志"
+FlowMind: [Uses sequential list automatically]
+```
+
+### Scene Mapping
+
+```bash
+# Define a workflow
+flowmind "排查问题先查错误日志，再查链路，最后查代码"
+FlowMind: ✓ Workflow saved
+
+# Use it anytime
+flowmind "排查线上问题 order-123"
+FlowMind: [Follows your workflow automatically]
+```
+
+### View Learnings
+
+```bash
+# List all learnings
+flowmind learn list
+
+# List scene mappings
+flowmind scenes list
+
+# Export for team sharing
+flowmind learn export team.json
+
+# Import from teammate
+flowmind learn import team.json
+```
+
+---
+
+## Common Commands
+
+| Command | Description |
+|---------|-------------|
+| `flowmind "your request"` | Execute a task |
+| `flowmind init` | Initialize configuration |
+| `flowmind skills` | List available skills |
+| `flowmind learn list` | View learning records |
+| `flowmind scenes list` | View scene mappings |
+| `flowmind learn export` | Export learnings |
+| `flowmind learn import` | Import learnings |
+
+---
+
+## Repeatable Terminal Demo
+
+From the repository root, you can replay the terminal walkthrough without requiring a global install:
+
+```bash
+./demo/setup-vhs-demo.sh
+./demo/01-skills.sh
+./demo/02-log-audit.sh
+./demo/03-learn-format.sh
+./demo/04-show-learning.sh
+./demo/05-log-audit-json.sh
+```
+
+If you want to render the animated terminal capture with VHS:
+
+```bash
+vhs demo/flowmind-demo.tape
+```
+
+## Tips
+
+1. **Be Specific**: More detailed instructions = better learning
+2. **Correct Early**: Tell FlowMind when it's wrong
+3. **Use Scenes**: Define workflows for repeated tasks
+4. **Share Knowledge**: Export and share with your team
+
+---
+
+<div align="center">
+
+**Learn once, flow forever.**
+
+</div>

package/demo/DEMO_CN.md

@@ -0,0 +1,263 @@
+<div align="center">
+
+# FlowMind 使用演示
+
+**如何在日常工作中使用 FlowMind**
+
+[English](DEMO.md)
+
+</div>
+
+---
+
+![FlowMind 终端演示](flowmind-demo.gif)
+
+## 快速开始
+
+### 安装
+
+```bash
+npm install -g flowmind
+```
+
+### 免安装试用
+
+```bash
+npx flowmind@latest skills
+npx flowmind@latest doctor
+```
+
+### 初始化
+
+```bash
+flowmind init
+```
+
+> 一次性配置，永久生效。配置资源连接、学习偏好、输出格式。
+
+---
+
+## 场景 1：线上问题排查
+
+**使用 FlowMind 前（10+ 步骤）：**
+```
+登录 SLS → 查日志 → 找 traceId → 查链路 → 连 RDS → 查数据 → 定位代码 → 修复 → 部署 → 写文档
+```
+
+**使用 FlowMind（1 个命令）：**
+```bash
+flowmind "排查线上问题 traceId abc123"
+```
+
+FlowMind 自动完成：SLS 查询 → 链路追踪 → RDS 数据验证 → 代码定位 → 修复建议
+
+### 分步操作
+
+```bash
+# 1. 用你喜欢的格式查询日志
+flowmind "查询 traceId abc123 的日志，用顺序列表格式"
+
+# 2. FlowMind 学习了你的偏好
+# 下次只需要：
+flowmind "查询 traceId def456 的日志"
+# → 自动使用顺序列表格式
+```
+
+---
+
+## 场景 2：代码审查
+
+### 设置你的标准（只需一次）
+
+```bash
+flowmind "代码审查先检查安全漏洞，再检查代码质量，最后检查性能"
+```
+
+### 审查任意 PR
+
+```bash
+flowmind "审查这个 PR"
+# → 安全优先 → 质量检查 → 性能分析
+```
+
+### 审查特定文件
+
+```bash
+flowmind "审查 src/api/users.js 的安全漏洞"
+```
+
+---
+
+## 场景 3：数据验证
+
+### 验证订单数据
+
+```bash
+flowmind "验证订单表数据完整性"
+# → 引用完整性 → 数据类型 → 业务逻辑 → 状态机
+```
+
+### 验证计算逻辑
+
+```bash
+flowmind "验证订单金额计算是否正确"
+```
+
+### 检查 Redis 缓存
+
+```bash
+flowmind "验证缓存逻辑，检查 store:{storeId}:config 的结构"
+```
+
+---
+
+## 场景 4：API 文档
+
+### 从代码生成
+
+```bash
+flowmind "从代码注释生成 API 文档"
+```
+
+### 同步到 YApi
+
+```bash
+flowmind "同步 OrderController 的接口到 YApi"
+```
+
+### 同步到语雀
+
+```bash
+flowmind "同步 API 文档到语雀"
+```
+
+---
+
+## 场景 5：日志分析
+
+### 链路追踪
+
+```bash
+flowmind "查询 traceId abc123 的完整链路"
+```
+
+### 错误排查
+
+```bash
+flowmind "查看最近1小时的错误日志"
+```
+
+### 性能分析
+
+```bash
+flowmind "分析 payment-service 接口耗时"
+```
+
+---
+
+## 场景 6：项目健康检查
+
+```bash
+flowmind "审查项目整体状况"
+# → 依赖分析 → 安全审计 → 代码复杂度 → 测试覆盖率 → 技术债务
+```
+
+### 安全审计
+
+```bash
+flowmind "进行安全审计"
+```
+
+---
+
+## 学习系统
+
+### 工作原理
+
+```bash
+# 第一次 - 教 FlowMind
+flowmind "查询日志用顺序列表格式"
+FlowMind: ✓ 已学习
+
+# 下次 - FlowMind 记住了
+flowmind "查询 traceId abc123 的日志"
+FlowMind: [自动使用顺序列表格式]
+```
+
+### 场景映射
+
+```bash
+# 定义工作流
+flowmind "排查问题先查错误日志，再查链路，最后查代码"
+FlowMind: ✓ 工作流已保存
+
+# 随时使用
+flowmind "排查线上问题 order-123"
+FlowMind: [自动遵循你的工作流]
+```
+
+### 查看学习记录
+
+```bash
+# 列出所有学习记录
+flowmind learn list
+
+# 列出场景映射
+flowmind scenes list
+
+# 导出供团队共享
+flowmind learn export team.json
+
+# 从队友导入
+flowmind learn import team.json
+```
+
+---
+
+## 常用命令
+
+| 命令 | 说明 |
+|------|------|
+| `flowmind "你的请求"` | 执行任务 |
+| `flowmind init` | 初始化配置 |
+| `flowmind skills` | 列出可用技能 |
+| `flowmind learn list` | 查看学习记录 |
+| `flowmind scenes list` | 查看场景映射 |
+| `flowmind learn export` | 导出学习记录 |
+| `flowmind learn import` | 导入学习记录 |
+
+---
+
+## 可重复终端演示
+
+在仓库根目录下，可以直接回放这套终端演示，不依赖全局安装：
+
+```bash
+./demo/setup-vhs-demo.sh
+./demo/01-skills.sh
+./demo/02-log-audit.sh
+./demo/03-learn-format.sh
+./demo/04-show-learning.sh
+./demo/05-log-audit-json.sh
+```
+
+如果要用 VHS 生成终端动画：
+
+```bash
+vhs demo/flowmind-demo.tape
+```
+
+## 使用技巧
+
+1. **描述具体**：指令越详细，学习效果越好
+2. **及时纠正**：告诉 FlowMind 哪里不对
+3. **善用场景**：为重复任务定义工作流
+4. **团队共享**：导出学习记录分享给团队
+
+---
+
+<div align="center">
+
+**学习一次，永远流畅。**
+
+</div>

package/demo/common.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+export FLOWMIND_HOME="${FLOWMIND_HOME:-$ROOT_DIR/.flowmind-demo}"
+
+if [[ "${FLOWMIND_USE_LOCAL:-0}" == "1" ]]; then
+  FLOWMIND_CMD=("node" "$ROOT_DIR/bin/flowmind.js")
+elif command -v flowmind >/dev/null 2>&1; then
+  FLOWMIND_CMD=("flowmind")
+else
+  FLOWMIND_CMD=("node" "$ROOT_DIR/bin/flowmind.js")
+fi
+
+flowmind_label() {
+  if [[ "${FLOWMIND_CMD[0]}" == "flowmind" ]]; then
+    printf 'flowmind'
+    return
+  fi
+
+  printf 'node ./bin/flowmind.js'
+}
+
+run_flowmind() {
+  "${FLOWMIND_CMD[@]}" "$@"
+}

package/demo/flowmind-demo.tape

@@ -0,0 +1,38 @@
+Output demo/flowmind-demo.gif
+
+Require node
+Require jq
+
+Set Shell "bash"
+Set FontSize 22
+Set Width 1100
+Set Height 760
+Set Padding 20
+Set Theme "Catppuccin Latte"
+Set WindowBar Colorful
+Set TypingSpeed 35ms
+Set Framerate 30
+
+Type "./demo/setup-vhs-demo.sh"
+Enter
+Sleep 1s
+
+Type "./demo/01-skills.sh"
+Enter
+Sleep 2s
+
+Type "./demo/02-log-audit.sh"
+Enter
+Sleep 2500ms
+
+Type "./demo/03-learn-format.sh"
+Enter
+Sleep 2500ms
+
+Type "./demo/04-show-learning.sh"
+Enter
+Sleep 2s
+
+Type "./demo/05-log-audit-json.sh"
+Enter
+Sleep 3s

package/demo/quickstart-demo.sh

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+source "$(cd "$(dirname "$0")" && pwd)/common.sh"
+FLOWMIND_LABEL="$(flowmind_label)"
+
+echo
+echo "== FlowMind quickstart demo =="
+echo
+
+echo "$ ${FLOWMIND_LABEL} skills --json"
+echo "This script uses the global FlowMind binary when available, otherwise falls back to the local repo binary."
+echo
+sleep 1
+
+run_flowmind skills --json || true
+echo
+sleep 1
+
+echo "$ ${FLOWMIND_LABEL} process --skill log-audit \"查询 traceId demo-123 的日志\" --json"
+run_flowmind process --skill log-audit "查询 traceId demo-123 的日志" --json || true
+echo
+sleep 1
+
+echo "$ ${FLOWMIND_LABEL} process \"下次日志结果用表格格式\""
+run_flowmind process "下次日志结果用表格格式" || true
+echo
+sleep 1
+
+echo "$ ${FLOWMIND_LABEL} process --skill log-audit \"查询 traceId demo-456 的日志\" --json"
+run_flowmind process --skill log-audit "查询 traceId demo-456 的日志" --json || true
+echo
+
+echo "== Demo complete =="

package/demo/setup-vhs-demo.sh

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+source "$(cd "$(dirname "$0")" && pwd)/common.sh"
+
+DEMO_HOME="$FLOWMIND_HOME"
+CONFIG_DIR="$DEMO_HOME/.flowmind"
+PACKAGE_VERSION="$(node -p "require('$ROOT_DIR/package.json').version")"
+
+rm -rf "$DEMO_HOME"
+mkdir -p "$CONFIG_DIR"
+
+cat > "$CONFIG_DIR/config.json" <<EOF
+{
+  "version": "$PACKAGE_VERSION",
+  "learning": {
+    "enabled": true,
+    "autoApply": true,
+    "confidenceThreshold": 0.7,
+    "storagePath": "$CONFIG_DIR/learning"
+  },
+  "sceneMapping": {
+    "enabled": true,
+    "weights": {
+      "keywordMatch": 0.4,
+      "patternMatch": 0.3,
+      "historyScore": 0.2,
+      "confidence": 0.1
+    }
+  }
+}
+EOF
+
+echo "Prepared demo home: $DEMO_HOME"