@louloulinx/metagpt 0.1.4 → 0.1.5

package/README.md

@@ -141,6 +141,111 @@ config.OPENAI_API_KEY = "sk-..."; // Your API key
 config.OPENAI_API_MODEL = "gpt-4-1106-preview"; // Model version
 ```
 
+## Tutorial Assistant Example
+
+The Tutorial Assistant is a specialized role that can generate comprehensive tutorial documents in Markdown format.
+
+```typescript
+import { VercelLLMProvider } from '@louloulinx/metagpt';
+import { TutorialAssistant } from '@louloulinx/metagpt';
+import { v4 as uuidv4 } from 'uuid';
+
+/**
+ * 教程助手示例
+ * 
+ * 该示例演示如何使用教程助手生成Markdown格式的教程文档
+ */
+async function main() {
+  console.log(`🚀 开始执行教程生成 [${new Date().toISOString()}]`);
+  
+  try {
+    // 从环境变量获取API密钥
+    const apiKey = process.env.DASHSCOPE_API_KEY;
+    console.log('✓ 检查环境变量');
+    
+    if (!apiKey) {
+      console.error('❌ 错误: 请设置环境变量: DASHSCOPE_API_KEY');
+      process.exit(1);
+    }
+    console.log('✓ 环境变量已设置');
+    
+    // 初始化Vercel LLM提供商 - 使用百炼大模型(qwen)
+    console.log('⚙️ 配置百炼大模型...');
+    const llmProvider = new VercelLLMProvider({
+      providerType: 'qwen',
+      apiKey,
+      model: 'qwen-plus-2025-01-25',
+      baseURL: 'https://dashscope.aliyuncs.com/compatible-mode/v1', // 自定义API端点
+      extraConfig: {
+        qwenOptions: {
+          debug: true, // 启用调试日志
+        },
+        generateOptions: {
+          system: '你是一位专业的教程编写专家，擅长生成高质量、结构清晰的教程文档。'
+        }
+      }
+    });
+    console.log(`✓ 模型配置完成: ${llmProvider.config?.providerType} - ${llmProvider.config?.model}`);
+    
+    console.log('⚙️ 初始化教程助手...');
+    console.time('教程助手初始化时间');
+    
+    // 创建教程助手
+    const tutorialAssistant = new TutorialAssistant({
+      llm: llmProvider,
+      language: 'Chinese', // 可选: 'English'
+      outputDir: './output/tutorials', // 可选，默认为 './tutorials'
+    });
+    
+    console.timeEnd('教程助手初始化时间');
+    console.log('✓ 教程助手初始化完成');
+    
+    // 设置要生成的教程主题
+    const topic = 'rust语言教程';
+    console.log(`📝 生成主题: "${topic}"`);
+    
+    // 生成教程
+    console.log('🔄 开始生成教程...');
+    console.log('👉 步骤 1: 生成目录结构');
+    console.time('教程生成总时间');
+    
+    const result = await tutorialAssistant.react({
+      id: uuidv4(),
+      role: 'user',
+      content: topic,
+      sentFrom: 'user',
+      sendTo: new Set(['*']),
+      instructContent: null,
+    });
+    
+    console.timeEnd('教程生成总时间');
+    console.log('✅ 教程生成完成!');
+    
+    // 提取文件路径（假设结果消息中包含文件路径信息）
+    const filePath = result.content.includes('saved to') 
+      ? result.content.split('saved to ')[1].trim()
+      : '未找到文件路径';
+    
+    console.log(`📄 生成结果: ${result.content}`);
+    console.log(`📂 输出文件: ${filePath}`);
+    console.log(`🏁 教程生成完成 [${new Date().toISOString()}]`);
+  } catch (error) {
+    console.error('❌ 生成教程时出错:', error);
+    if (error instanceof Error) {
+      console.error(`错误类型: ${error.name}`);
+      console.error(`错误信息: ${error.message}`);
+      console.error(`错误堆栈: ${error.stack}`);
+    }
+  }
+}
+
+// 运行示例
+console.log('📌 教程助手示例');
+main(); 
+```
+
+
+
 ## Basic Usage Example (Coming Soon)
 
 ```typescript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@louloulinx/metagpt",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "A TypeScript implementation of MetaGPT",
   "module": "src/index.ts",
   "type": "module",