Skip to content

开发指南

欢迎来到 AweeClaw 场景开发指南。无论你是想快速创建一个简单的 AI 对话助手,还是构建一个功能丰富的自定义 AI 应用,这里都有你需要的一切。

什么是场景(Scenario)?

场景是 AweeClaw 平台的核心概念。一个场景就是一个完整的 AI 应用,它定义了:

  • 身份:AI 的角色、系统提示词、行为规范
  • 能力:AI 可以使用的工具和功能
  • UI:用户界面布局和自定义面板
  • 数据:场景可以访问的数据源
  • 国际化:场景独立 i18n,支持多语言展示

两种开发模式

特性声明式(Declarative)编程式(Programmatic)
开发方式JSON 配置 + Markdown 文件TypeScript / JavaScript 代码
需要编程不需要需要
自定义 UI仅内置面板完整 React 组件
自定义工具基于模板配置完整 TypeScript 逻辑
适用场景对话助手、提示词模板复杂交互、数据可视化
发布格式配置文件 + 资源文件ESM Bundle

选择哪种模式?

选择声明式,如果你:

  • 想快速创建一个对话助手
  • 不需要复杂的自定义 UI
  • 工具逻辑可以通过模板配置实现
  • 不熟悉 TypeScript / React

选择编程式,如果你:

  • 需要自定义 React 面板组件
  • 需要复杂的工具逻辑
  • 需要与外部 API 交互
  • 需要完全控制场景行为

开发流程

mermaid
graph LR
    A[初始化项目] --> B[开发场景]
    B --> C[本地测试]
    C --> D[构建]
    D --> E[校验]
    E --> F[打包]
    F --> G[发布到市场]
  1. 初始化:使用 CLI 的 init 命令创建项目脚手架
  2. 开发:编写场景配置或代码
  3. 测试:使用 dev 命令在本地开发环境测试
  4. 构建:使用 build 命令编译场景
  5. 校验:使用 validate 命令检查构建产物
  6. 打包:使用 pack 命令打包为 tar.gz
  7. 发布:使用 publish 命令发布到场景市场

下一步

AweeClaw AI 应用构建平台