跳到主要内容
版本:8.2.0

如何快速搭建一个超级应用

产品介绍

超级应用

「超级应用」旨在将观远智能决策平台中现有能力原子化,构建 Agent 友好的开放平台。通过应用托管、CLI/Skill 与超级应用开发框架等模块,赋能企业级各类 AI、数据相关应用开发,支持客户内部 IT 与数据角色以及业务人员高效构建、集成、定制化数据分析、智能体相关应用。

超级应用的表现形式包括:

  • 静态网页
  • 动态网页(数据实时更新)
  • 小型业务系统
  • 决策系统(含数据、智能体对话框、业务动作联动)

超级应用开发框架

「超级应用开发框架」是一个前端代码示例库,内置观远 ADK、超级应用调试与发布框架,主要解决超级应用开发效率问题。

GuanCLI + SKILL

  • 「guancli」是一个命令行工具,只需一行指令即可在命令行中读取观远平台相关数据以及完成仪表板新建等操作。主要用来解决各类 Coding Agent 与观远平台交互的便利性与安全性问题。

  • 「guancli skill」是一个提供给 Coding Agent 使用的说明文件,让 AI 知道当用户提到 ETL、数据集、页面、卡片、血缘、SQL、目录、表单、ChatBI 时,应该优先使用 guancli。

    例如:当用户说“看一下这个 page”“这个数据集长什么样”“帮我查一下这个 ETL 的 SQL”“页面卡片用了哪些数据集”时,AI 能自动判断需要调用哪些命令。

免责条款

代码的灵活性也带来潜在安全风险。在保存相关代码或者启用相关代码前,建议各位管理员邀请企业内部相关技术专家、安全专家审阅、评估代码的潜在风险。 观远数据(乙方)不承担甲方错误、不当使用超级应用功能而引发的资产损失、数据损失、信息泄露等相关责任。

甲方需要特别注意不应当直接拷贝、使用外部第三方提供的代码或者软件包;不应当使用功能意图不明的代码与软件包。

准备工作

在开始搭建之前,请确保准备好以下工具:

  • 环境要求:Node.js
  • Coding Agent 编程智能体:如 Codex、Cursor、Trae、Claude Code 等

快速开始

  1. 安装 GuanCLI + SKILL
  2. 初始化应用项目
  3. 配置 BI 环境与鉴权
  4. 使用 Coding Agent 生成前端应用
  5. 打包发布至 BI
  6. 管理应用

使用指导

安装 GuanCLI + SKILL

  1. 安装 Node.js

    访问 https://nodejs.org/,下载并安装 LTS 版本的 Node.js(包含 npm)。

  2. 安装 guancli

    • 方法一:使用 npm 命令安装

      # 首次安装
      npm install -g @guandata/guancli

      # 已安装过的更新版本
      npm update -g @guandata/guancli
    • 方法二:下载安装包安装

      1. 下载 guancli 安装包:guandata-guancli-1.0.16.tgz
      2. 将安装包解压到目标项目文件夹
      3. 运行安装命令:
      npm install -g ./guandata-guancli-1.0.16.tgz

      安装完成后即可使用 guancli 命令行工具。

  3. 安装 guancli skill

    使用终端命令或者直接与大模型对话安装 guancli skill。

    guancli install-skill

初始化应用项目

创建应用项目

提供两种创建应用的方式

  • 方法一:使用 guancli 命令创建

    guancli app create --path [项目存放路径] --name [项目名称]
    说明
    • 若未指定项目存放路径,系统会自动选择默认路径存放项目。
    • 项目创建完成后系统会自动启动服务,若未自动启动,则可参考下方自行启动项目。
  • 方法二:与大模型对话创建应用

    |300

启动应用项目

  1. 启动应用项目

    • 方法一:命令行启动

      cd /项目目录 # 项目目录指的是有 package.json 文件的地方
      cp .env.template .env # 复制环境变量,仅首次启动需要
      npm run dev

      运行结果展示

      |400

    • 方法二:在 Coding Agent 编程智能体中打开创建的项目,通过自然语言直接启动项目。

  2. 在浏览器端打开应用地址,即可进入超级应用开发框架,后续的环境配置与打包发布均可在此页面进行。

配置 BI 环境与鉴权

  1. 点击「打开/dev」按钮配置应用环境。

  2. 填写环境配置,配置完成后点击「保存并立即生效」

配置项说明
Vite_Dev_Port本地开发调试时开发服务器的端口号。默认使用 http://localhost:8000 预览看板。如果跟其他服务冲突,可通过修改这个值来变更端口。
Vite_BI_Host后端观远 BI 服务器的访问地址,指定应用发布的目标域,数据集等资源来自该域。
配置账密登录当前域对应的账户,用于识别相应账户的权限,目前仅支持管理员账号发布应用。

UID_Token用于证明访问权限的安全令牌,在看板嵌入或 API 调用时标识当前用户身份,免去重复登录。

UID Token 获取方式

登录到要发布的域,通过浏览器开发者工具获取:「右键 > 检查 > 应用 > Cookie > 选择域 > uid Token」,Cookie Value 即为所需的 UID Token。

Vite_App_ID创建的应用在 BI 平台中的唯一标识符,应用首次发布成功后会自动生成。

使用 Coding Agent 生成前端应用

以下以搭建一个简单的看板 demo 为例进行说明。

  1. 用自然语言描述想要生成的前端应用。

    |400

    数据集 ID 的获取方式

    • 方法一:进入目标数据集的详情页,查看数据集的 URL,数据集 ID 为图中圈出的部分。

    • 方法二:直接与大模型对话,使用 guancli 能力获取数据集 ID ,例如:直接对话大模型「帮我找到名称为 XXX 数据集的 ID」。

  2. 大模型会根据要求生成 demo,可以根据自己想要达成的效果来进行描述,不断优化,直至大模型给出的前端 demo 符合要求。

打包发布至 BI

提供两种方法将生成的应用前端 demo 发布到 BI 中。

方法一:使用超级应用开发框架发布

  1. 进入/publish 下打包发布应用。

  2. 依次点击「打包发布」、「确认并开始构建」按钮。

  3. 点击「上传发布」按钮。

  4. 填写应用信息后点击「确认并上传发布」按钮。

  5. 发布成功后,会生成 SupperApp ID。

方法二:BI 管理中心手动上传发布

  1. 与大模型对话,输入「build」,生成 dist 文件夹,压缩成 dist.ZIP。

  2. 登录将要发布应用的 BI 环境,进入「管理中心 > 扩展应用」界面,点击「新建应用」按钮,填写应用名称和描述信息,上传 dist 压缩包,点击确认即可完成发布。

管理应用

功能入口:「BI 管理中心 > 扩展应用」

在应用列表中可以看到刚才成功发布的应用。

查看应用

点击「查看」,直接跳转到应用页。

更新应用

点击「更新应用文件」按钮,上传新版本的代码压缩包。

分享应用

点击「复制地址」按钮,复制应用地址进行分享。

编辑信息

点击「编辑应用信息」按钮,修改应用名称和描述。

配置应用

点击「配置应用」,即可打开 settings.json 文件进行编辑。

settings.json 用于存放各类动态配置内容,包括配置项、自定义文案、跳转链接、API 接口地址等。后续如需调整这类内容,可直接在管理后台在线修改,无需重新打包发布

如何使用

直接与 Coding Agent 对话,即可由其自动将动态内容相关的配置代码更新至 settings.json 文件。

下载应用

点击「下载」按钮,下载该应用的代码压缩包。

删除应用

点击「删除」按钮,将该应用从 BI 环境中删除。

权限说明

  • 发布权限:仅管理员角色拥有打包发布、管理应用权限,普通用户无此操作权限。
  • 访问权限:获取超级应用访问链接,登录后即可查看页面内容。若页面数据来源于数据集或仪表板卡片,则受 BI 权限管控。