mirror of
https://github.com/QwenLM/qwen-code.git
synced 2025-12-20 08:47:44 +00:00
docs(sdk): update sdk docs
This commit is contained in:
@@ -13,9 +13,8 @@ npm install @qwen-code/sdk
|
|||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- Node.js >= 20.0.0
|
- 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
|
## 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
|
## License
|
||||||
|
|
||||||
Apache-2.0 - see [LICENSE](./LICENSE) for details.
|
Apache-2.0 - see [LICENSE](./LICENSE) for details.
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@qwen-code/sdk",
|
"name": "@qwen-code/sdk",
|
||||||
"version": "0.5.1",
|
"version": "0.1.1",
|
||||||
"description": "TypeScript SDK for programmatic access to qwen-code CLI",
|
"description": "TypeScript SDK for programmatic access to qwen-code CLI",
|
||||||
"main": "./dist/index.cjs",
|
"main": "./dist/index.cjs",
|
||||||
"module": "./dist/index.mjs",
|
"module": "./dist/index.mjs",
|
||||||
|
|||||||
Reference in New Issue
Block a user