npm.io
0.1.20 • Published 6d agoCLI

@lark-apaas/miaoda-cli

Licence
MIT
Version
0.1.20
Deps
5
Size
802 kB
Vulns
0
Weekly
0
SummaryDependencyVersions

miaoda-cli

妙搭开发平台 Code Agent 命令行工具，为 Agent 提供原子能力。

安装

pnpm add -g @lark-apaas/miaoda-cli

使用

# 设置默认应用（需要应用上下文的命令可用 --app-id 覆盖）
export MIAODA_APP_ID=app_demo_xxx

# 文件操作
miaoda file ls
miaoda file upload ./local/path

JSON 结构化输出（Agent 推荐）：

# 输出全部字段
miaoda file ls --json

# 可选字段级选择
miaoda file ls --json id,name

# 或通过 --output 指定格式
miaoda file ls --output json

命令树

命令以"域"作为第一级命名空间：

域 用途
miaoda file ... 文件操作：上传、下载、元数据、签名下载、批量删除
miaoda db ... 数据操作：SQL 执行、表结构查询、数据导入导出
miaoda observability ... 线上日志、链路、前端源码堆栈反查、监控指标、运营指标

完整命令通过 miaoda --help 或 miaoda <domain> --help 查看。

全局参数

  • --json [fields]：输出结构化 JSON，可选字段级选择（如 --json id,name）。
  • --output <pretty|json>：输出格式，默认 pretty。
  • --verbose：输出调试日志到 stderr。

--app-id <id> 非全局参数，需要应用上下文的命令会各自声明，默认读取 MIAODA_APP_ID 环境变量。

环境变量

  • MIAODA_APP_ID：默认应用 ID，等价于 --app-id。
  • MIAODA_CANARY_HEADER：HTTP 请求的 x-tt-env 小流量头取值。未设置时默认 boe_miaoda_doubao；设为空字符串则不带该头（例：export MIAODA_CANARY_HEADER=boe_xxx）。值形如 ppe_xxx 时额外带上 x-use-ppe: 1。

输出契约

  • 默认文本输出（pretty），--json 或 --output json 切换为 JSON。
  • 错误始终写 stderr，业务数据写 stdout。
  • 完整的输出格式、JSON envelope、错误 shape、错误码前缀、退出码分类等见 Agent 友好 CLI 设计规范。

贡献

详见 AGENTS.md。

Keywords

miaodacliagent