vrr/qwen-code
2
0
Fork 0
mirror of https://github.com/QwenLM/qwen-code.git synced 2026-04-28 19:52:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 20

docs: add qwen auth CLI command documentation

Browse source
This commit is contained in:
LaZzyMan 2026-03-18 10:05:16 +08:00
parent 28149e0cc4
commit 40fceebbd6
3 changed files with 110 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

75
docs/users/configuration/auth.md
View file

@ -6,6 +6,61 @@ Qwen Code supports three authentication methods. Pick the one that matches how y
- **Alibaba Cloud Coding Plan**: use an API key from Alibaba Cloud. Paid subscription with diverse model options and higher quotas.
- **API Key**: bring your own API key. Flexible to your own needs — supports OpenAI, Anthropic, Gemini, and other compatible endpoints.
## Quick setup with `qwen auth`
The `qwen auth` CLI command lets you configure authentication directly from your terminal — no need to start an interactive session first.
### Interactive mode
Run `qwen auth` without arguments to get an interactive menu:
```bash
qwen auth
```
You'll see a selector with arrow-key navigation:
```
Select authentication method:
> Qwen OAuth - Free · Up to 1,000 requests/day · Qwen latest models
Alibaba Cloud Coding Plan - Paid · Up to 6,000 requests/5 hrs · All Alibaba Cloud Coding Plan Models
(Use ↑ ↓ arrows to navigate, Enter to select, Ctrl+C to exit)
```
### Direct subcommands
You can also skip the menu and run a specific authentication method directly:
| Command | Description |
| -------------------------------------------------- | ------------------------------------------------- |
| `qwen auth` | Interactive authentication setup |
| `qwen auth qwen-oauth` | Authenticate with Qwen OAuth |
| `qwen auth code-plan` | Authenticate with Alibaba Cloud Coding Plan |
| `qwen auth code-plan --region china --key sk-sp-…` | Non-interactive Coding Plan setup (for scripting) |
| `qwen auth status` | Show current authentication status |
**Examples:**
```bash
# Authenticate with Qwen OAuth directly
qwen auth qwen-oauth
# Set up Coding Plan interactively (prompts for region and key)
qwen auth code-plan
# Set up Coding Plan non-interactively (useful for CI/scripting)
qwen auth code-plan --region china --key sk-sp-xxxxxxxxx
# Check your current auth configuration
qwen auth status
```
> [!tip]
>
> You can also use the `/auth` slash command within an active Qwen Code session to change authentication methods interactively.
## Option 1: Qwen OAuth (Free)
Use this if you want the simplest setup and you're using Qwen models.
@ -21,6 +76,12 @@ Start the CLI and follow the browser flow:
qwen
```
Or authenticate directly without starting a session:
```bash
qwen auth qwen-oauth
```
> [!note]
>
> In non-interactive or headless environments (e.g., CI, SSH, containers), you typically **cannot** complete the OAuth browser login flow.
@ -44,6 +105,20 @@ Alibaba Cloud Coding Plan is available in two regions:
### Interactive setup
You can set up Coding Plan authentication in two ways:
**Option A: From the terminal (recommended for first-time setup)**
```bash
# Interactive — prompts for region and API key
qwen auth code-plan
# Or non-interactive — pass region and key directly
qwen auth code-plan --region china --key sk-sp-xxxxxxxxx
```
**Option B: Inside a Qwen Code session**
Enter `qwen` in the terminal to launch Qwen Code, then run the `/auth` command and select **Alibaba Cloud Coding Plan**. Choose your region, then enter your `sk-sp-xxxxxxxxx` key.
After authentication, use the `/model` command to switch between all Alibaba Cloud Coding Plan supported models (including qwen3.5-plus, qwen3-coder-plus, qwen3-coder-next, qwen3-max, glm-4.7, and kimi-k2.5).