mirror of
https://github.com/modelstudioai/cli.git
synced 2026-09-14 19:49:23 +08:00
zeyu.fz
43abf0aca5
- 增加test:journey脚本，覆盖知识库跨命令全链路用户旅程测试 - 在文档中新增Journey E2E章节，详细说明用户旅程测试定位及断言机制 - 完善commands模块，新增知识库相关命令包括知识库列表、信息、创建、更新、删除 - 新增知识库文档相关命令，如文档列表、状态、上传、删除、打标签及OSS导入 - 添加知识服务管理命令，支持列表、创建、更新、部署、删除及复制 - 支持知识块增删查改命令，完善知识点的灵活操作能力 - 实现数据中心分类管理命令，支持分类增删查操作 - 优化knowledge chat命令，增加workspace-id统一解析及agent-version版本控制 - 重构与知识库相关命令的导出与注册，完善CLI整体能力覆盖 - 新增命令详尽的帮助文档，包含参数说明、使用示例及错误边界 - 实现批量删除知识块的自动分批处理逻辑，易于操作大规模数据 - 添加必要的输入校验与安全提示，确保操作安全且符合规范
Knowledge Studio CLI
Lightweight RAG CLI for Aliyun Model Studio — focused on knowledge-base retrieval.
What is this?
kscli is a standalone CLI for knowledge-base retrieval on Aliyun Model Studio (DashScope), purpose-built for RAG (Retrieval-Augmented Generation) workflows.
Installation
npm install -g knowledge-studio-cli
Requires Node.js >= 18.17.
Quick Start
# Search a knowledge base
kscli search \
--query "What is Model Studio?" \
--agent-id <your-agent-id> \
--workspace-id <your-workspace-id>
# Chat with a knowledge base
kscli chat \
--message "What is RAG?" \
--agent-id <your-agent-id> \
--workspace-id <your-workspace-id>
Commands
| Command | Description |
|---|---|
search |
Semantic search across knowledge bases (RAG) |
chat |
Knowledge-base Q&A with streaming (RAG) |
retrieve |
Query a knowledge base (deprecated, use search) |
config show |
Display current configuration |
config set |
Set a configuration value |
update |
Self-update to the latest version |
Authentication
A DashScope API Key is recommended. Get yours from the DashScope Console.
# Option 1: Environment variable
export DASHSCOPE_API_KEY=sk-xxxxx
# Option 2: Persist to config (~/.bailian/config.json)
kscli config set --key api_key --value sk-xxxxx
# Option 3: Per-command flag
kscli search --api-key sk-xxxxx --query "..." --agent-id <id> --workspace-id <id>
Configuration
# View current config
kscli config show
# Set defaults
kscli config set --key base_url --value https://dashscope-us.aliyuncs.com
kscli config set --key timeout --value 600
# Self-update
kscli update
Config file location: ~/.bailian/config.json
Links
| Resource | URL |
|---|---|
| Knowledge Studio Console | https://rag.console.aliyun.com/ |
| DashScope API Docs | https://help.aliyun.com/zh/model-studio/ |
| Get API Key | https://bailian.console.aliyun.com/?tab=app#/api-key |
Contributing
Bug reports, feature requests, and PRs are welcome. See CONTRIBUTING.md for developer setup and contribution workflow.