WriteFlow AI 写作助手

✨ 核心特性

🚀 快速开始

安装

# 方法一:从 NPM 安装(推荐)
npm install -g writeflow
# 方法二:从源码安装
git clone https://github.com/wordflowlab/writeflow.git
cd writeflow
npm install
npm run build
npm install -g .

配置 API 密钥

# 选择默认提供商与模型
export API_PROVIDER=deepseek
export AI_MODEL=deepseek-chat
# 设置密钥(示例:DeepSeek)
export DEEPSEEK_API_KEY="your-deepseek-api-key"
# 如需自定义网关
export API_BASE_URL="https://api.deepseek.com"
# 其他提供商示例
export ANTHROPIC_API_KEY="your-anthropic-key"
export OPENAI_API_KEY="your-openai-key"
export KIMI_API_KEY="your-kimi-key" # 或 MOONSHOT_API_KEY
export BIGDREAM_API_KEY="your-bigdream-key"

基本使用

# 启动交互模式(推荐)
writeflow
# 直接执行单个斜杠命令
writeflow exec "/outline AI技术发展趋势"

📋 命令参考

斜杠命令系统

# 在交互模式中使用斜杠命令
writeflow> /outline <主题> [选项]
writeflow> /rewrite <风格> <内容或文件路径> [选项] 
writeflow> /research <主题> [选项]
writeflow> /publish <平台> <文件> [选项]
writeflow> /help # 查看所有命令
# 支持中英文别名
writeflow> /大纲 AI技术发展 # 等同于 /outline
writeflow> /改写 通俗 ./article.md
writeflow> /研究 量子计算
writeflow> /帮助 # 等同于 /help

命令选项

# 生成文章大纲
/outline <主题> --style=技术|正式|通俗|学术 --length=2000
# 智能改写内容
/rewrite <风格> <内容或文件路径>
# 深度主题研究
/research <主题> --depth=标准|深入 --sources=8 --time=最近一年 --lang=中文|英文
# 发布到平台
/publish <平台> <文件路径> --tags=AI,技术 --lang=zh|en
# 格式转换
/format <目标格式> <文件路径> --preserve-style=true --output=./输出路径.md

CLI 系统命令

# 启动交互模式(默认)
writeflow
# 直接执行斜杠命令
writeflow exec "/outline AI技术发展"
writeflow exec "/help"
# 配置管理
writeflow config --set model=claude-3-opus-20240229
writeflow config --get model
writeflow config --list
# 系统状态
writeflow status

🏗️ 架构设计

核心组件

┌─────────────────────────────────────────────────┐
│ WriteFlow CLI │
├─────────────────────────────────────────────────┤
│ 斜杠命令系统 │ 交互界面 │ 配置管理 │
├─────────────────────────────────────────────────┤
│ 工具系统 (Tool Manager) │
│ 基础工具 │ 写作工具 │ 研究工具 │ 发布工具 │
├─────────────────────────────────────────────────┤
│ nO Agent 引擎 │
│ 消息处理 │ 任务调度 │ 状态管理 │
├─────────────────────────────────────────────────┤
│ h2A消息队列 │ wU2上下文管理 │ 六层安全验证 │
└─────────────────────────────────────────────────┘

性能指标

🛠️ 开发指南

项目结构

src/
├── cli/ # CLI 界面
│ ├── commands/ # 斜杠命令
│ ├── executor/ # 命令执行器
│ ├── parser/ # 命令解析器
│ ├── interactive/ # 交互式 UI
│ ├── index.ts # CLI 运行入口
│ └── writeflow-cli.ts # CLI 主类
├── core/ # 核心引擎
│ ├── agent/ # nO Agent 系统
│ ├── context/ # wU2 上下文管理
│ ├── queue/ # h2A 消息队列
│ └── security/ # 安全框架
├── services/ # 外部服务与 AI 调用
│ ├── ai/ # AI 服务封装
│ └── models/ # 模型与提供商定义
├── tools/ # 工具系统
│ ├── base/ # 基础文章操作
│ ├── writing/ # 写作工具
│ ├── research/ # 研究工具
│ └── publish/ # 发布工具
├── ui/ # 终端 UI 组件(Ink)
└── types/ # TypeScript 类型定义

本地开发

# 开发模式
npm run dev
# 运行测试
npm test
npm run test:watch
# 类型检查
npm run typecheck
# 代码检查
npm run lint

添加自定义工具

import { WritingTool, ToolInput, ToolResult } from '@/types/tool.js'
export class CustomTool implements WritingTool {
 name = 'custom_tool'
 description = '自定义工具描述'
 securityLevel = 'safe'
 
 async execute(input: ToolInput): Promise<ToolResult> {
 // 实现自定义逻辑
 return {
 success: true,
 content: '处理结果'
 }
 }
}

添加自定义命令

{
 type: 'prompt',
 name: 'custom_command',
 description: '自定义命令',
 aliases: ['自定义', 'cc'],
 async getPromptForCommand(args: string): Promise<string> {
 return `自定义提示词: ${args}`
 },
 userFacingName: () => 'custom_command'
}

🧪 测试

# 运行所有测试
npm test
# 测试特定组件
npm run test:queue # 消息队列测试
npm run test:agent # Agent 引擎测试
npm run test:tools # 工具系统测试
# 端到端测试
npm run test:e2e
# 性能基准测试
npm run benchmark

📊 监控和调试

# 启用详细调试
DEBUG=writeflow:* writeflow exec "/outline AI技术"
# 特定组件调试
DEBUG=writeflow:h2a,writeflow:nO writeflow exec "/research 机器学习"
# 性能分析
writeflow status
writeflow config --get performance

🤝 贡献指南

开发规范

📄 许可证

🙏 致谢