Skip to main content

命令参考

本页汇总 LinkAI CLI 的全部命令。每个命令都可运行 linkai <命令> --help 查看完整参数。

通用约定​

  • --json：输出结构化 JSON，便于 Agent 或脚本解析。
  • --dry-run：预览将要发送的请求，不实际执行（适用于写操作）。
  • --force：跳过交互式确认（如 knowledge delete）。
  • 退出码：0 成功 / 1 一般错误 / 2 参数错误 / 3 认证或权限错误 / 4 网络错误。

登录认证 auth​

登录采用 OAuth 设备码流程，需在浏览器中完成授权。

命令说明
linkai auth login登录，--scope 申请权限
linkai auth logout登出（同步吊销服务端 token）
linkai auth status查看登录状态（valid / needs_refresh / expired）
linkai auth login
linkai auth status --json

应用 app​

查询、创建与管理 AI 应用。

命令说明所需权限
linkai app list [--key <关键词>] [--page <n>]查看应用列表，获取 app_codeapp:read
linkai app detail <app_code>查看应用详情与配置app:read
linkai app create --name <name> [--type <t>] [--desc <txt>] [--prompt <txt>] [--intro <txt>]创建应用（--name 必填，--type 默认 PROMPT）app:create
linkai app update <app_code> [--name ...] [--desc ...] [--prompt ...] [--intro ...]更新应用（仅更新传入字段）app:update
linkai app delete <app_code> --force删除应用app:delete
  • create 的 --type 可选 PROMPT（默认，轻量应用）/ EMBEDDING / WORKFLOW / AGENT；--prompt 为系统提示词、--intro 为开场白。

对话 chat​

与 AI 应用或语言模型对话，支持多轮会话。

linkai chat "<消息>" [--app <app_code>] [--model <model_code>] [--session <id>] [--no-stream] [--json]
  • --app：与配置好的应用对话（app_code 来自 linkai app list）。
  • --model：直接调用某个语言模型（model_code 来自 linkai model list）。
  • 两者都不传时使用平台默认模型；同时传入时 --model 覆盖应用配置的模型。
  • --session <id>：跨多次调用传入同一 id 即可保持上下文，实现多轮对话。

知识库 knowledge​

向量检索私有知识库，管理知识库、文件与条目。

命令说明所需权限
linkai knowledge list查看知识库列表，获取 kb_codeknowledge:read
linkai knowledge files <kb_code> [--name <kw>] [--page <n>]查看知识库中的文件knowledge:read
linkai knowledge search <kb_code> "<query>" [--k <n>]向量检索（--k 返回条数，默认 5）knowledge:read
linkai knowledge create --name <name> [--desc <txt>]创建知识库knowledge:create
linkai knowledge update <kb_code> [--name ...] [--desc ...]更新知识库knowledge:update
linkai knowledge add <kb_code> (--text <txt> \| --question <q> --answer <a>) [--file-id <id>]添加单条内容（纯文本片段或问答对）knowledge:create
linkai knowledge import <kb_code> --file <path> [--type doc\|qa\|table]导入整个本地文件（文档 / 问答表 / 数据表）knowledge:create
linkai knowledge file delete <kb_code> --file-id <id> --force删除某个文件及其全部条目knowledge:delete
linkai knowledge data delete <kb_code> --file-id <id> --id <data_id> --force删除文件中的单条内容knowledge:delete
linkai knowledge delete <kb_code> --force删除整个知识库knowledge:delete
  • add vs import：add 用于内联的单条文本片段或问答对；import 用于上传整个本地文件（等同平台的文件导入）。--type 可选 doc（默认，非结构化文档 pdf/txt/word/md 等）、qa（两列问答表）、table（多列数据表）。
  • 导入是异步的：import / add 提交后即返回，可用 knowledge files <kb_code> 轮询确认文件已完成嵌入。
  • 三级删除：file delete 删整个文件、data delete 删文件内单条、knowledge delete 删整个知识库。--file-id 可从 knowledge files 结果的 fileId 字段获取。

数据库 database​

查询业务数据库、表结构，执行 SQL；也可创建平台托管的内置数据库与表。

命令说明所需权限
linkai database list查看数据库列表，获取 db_codedb:read
linkai database tables <db_code>查看数据表列表db:read
linkai database describe <db_code> <table>查看表结构（字段 + 类型）db:read
linkai database exec <db_code> "<SQL>"执行 SQL（SELECT 需 db:read，增删改需 db:write）db:read / db:write
linkai database create --name <name> [--description <txt>]创建内置（平台托管）数据库db:write
linkai database create-table <db_code> --name <table> --field name:type[:comment] ...在内置数据库中创建表db:write
  • 内置数据库完整流程：create 建库 → create-table 定义列 → exec 执行 INSERT/SELECT 读写数据。create / create-table 仅适用于内置数据库，不支持外部连接。
  • 建表字段类型：text / text1024 / longtext / number / decimal / datetime，系统会自动添加自增主键 id。
  • 安全限制：DDL（DROP / TRUNCATE / ALTER / CREATE TABLE）在客户端被拦截，建表请用 create-table；探索性查询建议带上 LIMIT。

工作流 workflow​

运行、创建与管理 LinkAI 上编排的工作流。

命令说明所需权限
linkai workflow list查看工作流列表，获取 app_codeworkflow:read
linkai workflow run <app_code> --input "<文本>" [--arg k=v ...] [--session <id>]运行工作流workflow:run
linkai workflow create --name <name> [--desc <txt>]创建空白工作流（节点编排在控制台完成）workflow:create
linkai workflow update <code> [--name ...] [--desc ...]更新工作流workflow:update
linkai workflow delete <code> --force删除工作流workflow:delete
  • --arg 可重复传入工作流所需的额外参数；--session <id> 传入同一 id 可启用多轮上下文。
  • create 创建的是空白工作流，返回结果中的 links.console 链接可直接打开控制台的编排器。

插件 plugin​

调用平台插件能力。

命令说明
linkai plugin list [--category <name>]查看插件列表，可按分类筛选
linkai plugin detail <plugin_code>查看插件详情（确认所需 input 与 args）
linkai plugin exec <plugin_code> --input "<文本>" [--arg key=value ...]执行插件
  • --arg 可重复，每个 key=value 为一个参数；执行前建议先用 detail 确认参数结构。

内容生成 image / video / audio​

linkai image gen "<描述>" [--model <m>] [--size <s>] [--aspect-ratio <r>] [--quality <q>] [--image <url>]...
linkai video gen "<描述>" [--model <m>] [--duration <sec>] [--aspect-ratio <r>] [--mode std|pro] [--image <url>]...
linkai audio speech "<文本>" [--model tts-1|tts-1-hd] [--voice <id>] [--output <path.mp3>]
命令说明
image gen文生图 / 图生图（--image 传参考图，可重复），输出图片链接
video gen文生视频 / 图生视频，内置轮询等待完成（约 30s–3min，无需自行轮询）
audio speech语音合成（TTS）；不带 --output 返回链接，带 --output 下载到本地
  • 不要硬编码模型名：省略 --model 使用账户默认模型，或用 linkai model list --type IMAGE（或 VIDEO）查询后传入。
  • --size / --aspect-ratio / --quality / --duration / --mode 等均为模型相关参数，不填则用模型默认值。

模型 model​

linkai model list [--type LLM|EMBEDDING|IMAGE|VIDEO] [--supplier <厂商>]

查询可用模型，--type 按类型筛选、--supplier 按厂商筛选。

账户与积分 account​

命令说明所需权限
linkai account info查看账号信息与积分余额user:read
linkai account credits查看可购买的积分套餐score:read
linkai account recharge --product <id> --pay wechat\|alipay充值购买积分（返回支付二维码）score:buy
linkai account order <order_no>按订单号查询订单状态score:read
linkai account orders查看购买历史score:read

更新 update​

linkai update 可原地升级 CLI（自动识别 npm / Homebrew / go / 脚本安装方式）。

linkai update --check    # 仅检查：当前版本 / 最新版本 / 是否有更新
linkai update            # 执行升级

若遇到 unknown flag 或命令缺失，通常是 CLI 版本过旧，运行 linkai update 升级即可。

权限​

权限在登录时通过 --scope 申请，格式为「资源:动作」。默认授予查询（read）与创建（create）等常用低风险操作；更新、删除、数据库写入等破坏性操作需显式申请。

权限说明默认授予
app:read查询应用列表、详情✅
app:create创建应用✅
user:read查询用户信息✅
chat:send与应用对话✅
knowledge:read查询知识库✅
knowledge:create创建知识库 / 添加、导入文件✅
db:read查询数据库 / 执行 SELECT✅
image:gen / video:gen / audio:gen生成图片 / 视频 / 语音✅
plugin:read / plugin:run查询 / 执行插件✅
workflow:read / workflow:run查询 / 运行工作流✅
workflow:create创建工作流✅
score:read / score:buy查看 / 购买积分✅
app:update / app:delete更新 / 删除应用❌
knowledge:update / knowledge:delete更新 / 删除知识库、文件、条目❌
workflow:update / workflow:delete更新 / 删除工作流❌
db:write数据库写操作（创建库表、INSERT/UPDATE/DELETE）❌

申请额外权限时重新登录，例如：

linkai auth login --scope "db:read db:write knowledge:update knowledge:delete app:update app:delete"

安全设计​

  • Token：Opaque token 服务端存储、可撤销；access 2h / refresh 7d，到期前自动刷新；logout 同步吊销服务端 token。
  • 设备绑定：请求携带 X-Device-ID，服务端绑定 token 与设备。
  • 本地存储：macOS 存入系统钥匙串（服务名 linkai-cli），其他平台文件存储（0600）；配置在 ~/.linkai/。
  • 输入 / 输出防护：拒绝危险 Unicode，数据库禁 DDL，表格输出剥离 ANSI。
  • 容错：5xx 自动指数退避重试；退出码结构化，便于程序判断。