@syngy/botworks-admin

Tenant admin CLI for BotWorks.

Install

npm install -g @syngy/botworks-admin

Login

botworks-admin auth login
botworks-admin auth whoami
botworks-admin auth logout

The CLI reuses the browser-assisted tenant-admin login flow and opens https://admin.autostaff.cn.

Implementation Notes

• Runtime API calls use the generated tenant-admin SDK
• The generated SDK is bundled into the published package at build time, so install users do not depend on the workspace source tree
• File-based digiworker input is validated with zod
• Auth session credentials are stored locally and reused by all subcommands

Commands

botworks-admin skill list --json
botworks-admin skill list --path-prefix "验光师/" --json
botworks-admin skill list --all --json
botworks-admin skill assign-skillset <skill-id> --skillset-id <skillset-id>
botworks-admin skill batch-assign-skillset --skill-ids s1,s2 --skillset-id ss_1
botworks-admin skill batch-assign-skillset --by-query "验光师" --skillset-id ss_1
botworks-admin skill batch-assign-skillset --by-path-prefix "验光师/" --skillset-id ss_1
botworks-admin skill sync

botworks-admin skillset list --json
botworks-admin skillset get <skillset-id>
botworks-admin skillset get --name "验光师"
botworks-admin skillset create --name "Default" --description "Core skills"
botworks-admin skillset create --name "验光师" --upsert --json
botworks-admin skillset update <skillset-id> --name "Ops"
botworks-admin skillset delete <skillset-id>

botworks-admin job-tag list --json
botworks-admin job-tag get <job-tag-id>
botworks-admin job-tag get --code "customer_service"
botworks-admin job-tag create --label "客服" --code "customer_service" --sort 10 --json
botworks-admin job-tag update <job-tag-id> --label "运营" --portal-selectable true
botworks-admin job-tag delete <job-tag-id>

botworks-admin digiworker list --json
botworks-admin digiworker list --job-tag-id <job-tag-id> --json
botworks-admin digiworker get <worker-id>
botworks-admin digiworker create --file worker.json
botworks-admin digiworker update <worker-id> --file worker.patch.json
botworks-admin digiworker refresh-avatar <worker-id>

Digiworker File Input

{
  "name": "Ops Worker",
  "llmModelId": "qwen3-max",
  "hireableCount": 3,
  "marketVisible": true,
  "autohire": false,
  "jobTagIds": ["jt_customer_service"],
  "skillsetIds": ["ss_ops"],
  "toolkitKeys": ["browser", "search"]
}

Batch Workflow

推荐的按目录批量归类链路：

botworks-admin skillset create --name "验光师" --upsert --json
botworks-admin skill batch-assign-skillset --by-path-prefix "验光师/" --skillset-id ss_optician

如果只想预览目录下的全部 skill：

botworks-admin skill list --path-prefix "验光师/" --all --json

Errors

当命令带 --json 且失败时，CLI 会输出结构化错误：

{
  "code": "AUTH_REQUIRED",
  "message": "Unauthorized. Please run: botworks-admin auth login",
  "hint": "Run auth login and retry the command"
}

退出码约定：

• 2: auth required
• 3: validation error
• 4: not found
• 5: request failed