From 3354b56a05338cd08b9d2f39bec1cbc95b883cee Mon Sep 17 00:00:00 2001 From: "mingholy.lmh" Date: Fri, 19 Dec 2025 15:36:45 +0800 Subject: [PATCH] docs(sdk): update sdk docs --- packages/sdk-typescript/README.md | 20 ++++++++++++++++++-- packages/sdk-typescript/package.json | 2 +- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/packages/sdk-typescript/README.md b/packages/sdk-typescript/README.md index bc3ef6aa..a9699b02 100644 --- a/packages/sdk-typescript/README.md +++ b/packages/sdk-typescript/README.md @@ -13,9 +13,8 @@ npm install @qwen-code/sdk ## Requirements - Node.js >= 20.0.0 -- [Qwen Code](https://github.com/QwenLM/qwen-code) >= 0.4.0 (stable) installed and accessible in PATH -> **Note for nvm users**: If you use nvm to manage Node.js versions, the SDK may not be able to auto-detect the Qwen Code executable. You should explicitly set the `pathToQwenExecutable` option to the full path of the `qwen` binary. +> From v0.1.1, the CLI is bundled with the SDK. So no standalone CLI installation is needed. ## Quick Start @@ -372,6 +371,23 @@ try { } ``` +## FAQ / Troubleshooting + +### Version 0.1.0 Requirements + +If you're using SDK version **0.1.0**, please note the following requirements: + +#### Qwen Code Installation Required + +Version 0.1.0 requires [Qwen Code](https://github.com/QwenLM/qwen-code) **>= 0.4.0** to be installed separately and accessible in your PATH. + +```bash +# Install Qwen Code globally +npm install -g qwen-code@^0.4.0 +``` + +**Note**: From version **0.1.1** onwards, the CLI is bundled with the SDK, so no separate Qwen Code installation is needed. + ## License Apache-2.0 - see [LICENSE](./LICENSE) for details. diff --git a/packages/sdk-typescript/package.json b/packages/sdk-typescript/package.json index 6de4ff97..f80c61c4 100644 --- a/packages/sdk-typescript/package.json +++ b/packages/sdk-typescript/package.json @@ -1,6 +1,6 @@ { "name": "@qwen-code/sdk", - "version": "0.5.1", + "version": "0.1.1", "description": "TypeScript SDK for programmatic access to qwen-code CLI", "main": "./dist/index.cjs", "module": "./dist/index.mjs",