跳到主要内容

快速开始

本页介绍如何安装 OpenInsight CLI，并初始化一个本地数据分析库。

安装 CLI​

使用 Agent 安装​

在 Codex、Claude Code 等 Agent 工具中，可以直接发送：

帮我按照这个文档安装 OpenInsight：curl -fsSL https://openinsight-cli.oss-cn-hangzhou.aliyuncs.com/release/install.sh | bash

Agent 会在本机执行安装脚本，并帮助确认 openinsight 命令是否可用。

使用命令安装​

使用发布脚本安装最新版本：

curl -fsSL https://openinsight-cli.oss-cn-hangzhou.aliyuncs.com/release/install.sh | bash

安装完成后检查命令是否可用：

openinsight --version

初始化数据分析库​

执行 setup 创建 OpenInsight 本地数据分析库：

openinsight setup ./analytics-repo

./analytics-repo 是数据分析库根目录。setup 会在它下面继续创建一个 project 目录，例如默认 project 是 default，最终目录是 ./analytics-repo/default/。

执行命令后会依次出现以下输入项。带括号的是默认值，直接按 Enter 会使用默认值。

开始引导完成项目初始化。
Project name (default):

输入 project 名称，例如 default、sales、hangqing。名称只能包含字母、数字、点、下划线和中划线，并且必须以字母或数字开头。

Provider code（当前可选 yuce：预策数据平台） (yuce):

输入数据平台 provider code。当前支持 yuce，通常直接按 Enter 即可。

预策 API endpoint，例如 https://host:

输入预策站点根地址或 API endpoint，例如：

https://your-yuce-host

也可以输入已经带 /api 的地址。OpenInsight 会在写入配置时规范化 endpoint。

Personal Access Token (https://your-yuce-host/#/personal-access-token):

输入预策 Personal Access Token。Token 会写入当前 project 的 .open-insight.json，该文件用于后续命令访问数据平台。

初始化项目文件后，默认还会继续安装内置 Agent skills：

初始化完成，接下来安装 Agent skills。
选择要安装到的 Agent 工具：
    1. Cursor
    2. Claude Code
  * 3. Codex
    4. 生意高手
请选择 (Codex):

可以输入序号 1 / 2 / 3 / 4，也可以输入工具值 cursor / claude / codex / shengyigaoshou；直接按 Enter 会选择 Codex。

选择安装范围：
  * 1. 全局（用户目录）
    2. 项目（当前仓库根目录）
请选择 (全局（用户目录）):

可以输入序号 1 / 2，也可以输入 global / project；直接按 Enter 会安装到全局用户目录。若希望只在当前数据分析库使用这些 skills，选择 project。生意高手会安装到 .system/skills/custom/（全局为用户目录下，项目为仓库根目录下）。

初始化完成后，命令会输出类似信息：

已初始化 Open Insight 数据分析库：/path/to/analytics-repo
已创建 project：default
已写入本地配置：/path/to/analytics-repo/default/.open-insight.json
已将 3 个内置 skill 安装到 Codex（全局）。
目标目录：/Users/you/.codex/skills

生成的目录结构大致如下：

analytics-repo/
└── default/
    ├── .open-insight.json
    ├── cache.yaml
    ├── datasets/
    ├── knowledge/
    ├── skills/
    └── source/
        ├── clusters/
        ├── systems/
        ├── tables/
        ├── tasks/
        └── taskruns/

.open-insight.json 包含 endpoint 和 Personal Access Token，只应保存在本地，不要提交到 Git。

初始化完成后进入数据分析库：

cd ./analytics-repo/default
openinsight current

如果初始化时使用了其他 project 名称，例如 --project sales，则进入对应目录：

cd ./analytics-repo/sales
openinsight current

验证服务​

进入 project 目录后，执行仪表盘列表查询：

openinsight dashboard list

如果能看到仪表盘列表，说明配置成功

如果提示认证失败、连接失败或没有权限，请检查：

  • endpoint 是否是正确的预策站点地址。
  • Personal Access Token 是否仍然有效。
  • 当前账号是否有查看仪表盘的权限。

在 Codex 中使用​

如果使用 Codex，建议为每个 OpenInsight project 单独创建一个 Codex 项目，并把项目路径指向具体的 project 目录，例如：

/path/to/analytics-repo/default
/path/to/analytics-repo/sales

在 Codex 项目列表中点击新增，然后选择“使用现有文件夹”，再选择对应的 OpenInsight project 目录。

Codex 使用现有文件夹

这样 Codex 在该项目中运行时，会直接读取当前目录下的 .open-insight.json，后续查询和诊断也会自动使用对应 project 的数据上下文。

更多多项目配置方式见 最佳实践：多项目管理。