OSDK CLI 使用指南

@loambase/osdk-cli 是管理 workspace、ontology schema 以及对象数据的命令行工具。

安装

npm install -g @loambase/osdk-cli
 
osdk --version
osdk --help

完整工作流演示

以下脚本演示了从初始化到写入/查询 customer 对象的完整流程：

#!/bin/bash
set -e
 
# 1. 初始化 CLI：保存 base-url、token 和默认 workspace
osdk init \
  --token <your_pat_token> \
  --base-url https://tenant-1.loambase.com \
  --yes
 
# 2. 创建并切换到新 workspace
osdk workspace create --name cli-demo --use
osdk workspace current
 
# 3. 创建 schema
osdk schema create \
  --name customer \
  --display-name "Customer" \
  --primary-key id \
  --field id:STRING \
  --field name:STRING \
  --field age:INTEGER
 
# 4. 发布对象（包含运行态与物理层同步，写入数据的前置条件）
osdk schema publish customer
 
# 5. 授权（默认授予 WS_ADMIN 角色 READ 权限）
osdk permission grant customer
 
# 6. 插入/更新数据
osdk data upsert customer \
  --primary-key-value c1 \
  --field id=c1 \
  --field name=Alice \
  --field age=30
 
# 主键相同即为更新
osdk data upsert customer \
  --primary-key-value c1 \
  --field id=c1 \
  --field name="Alice Smith" \
  --field age=31
 
# 7. 查询数据
osdk data list customer --limit 10
osdk data list customer --limit 10 --filter "age > 25"

常用命令速查

# workspace 管理
osdk workspace ls
osdk workspace current
osdk workspace use <workspace-id>
osdk workspace create --name <name> --use
 
# schema 管理
osdk schema ls
osdk schema get <apiNameOrId>
osdk schema create --file <schema.json>
osdk schema create --name <name> --primary-key <pk> --field <spec>
osdk schema publish <apiNameOrId>
 
# 数据操作
osdk data upsert <object> --primary-key-value <pk> --field <key=value>
osdk data list <object> --limit 10 --filter "name = Alice"
 
# 权限管理
osdk permission ls
osdk permission grant <object> [--action READ] [--subject WS_ADMIN] [--subject-type ROLE]