* fix(cli): add "API Key" option to `qwen auth` interactive menu The `qwen auth` CLI command only showed 2 options (Coding Plan, Qwen OAuth), while the interactive `/auth` dialog showed 3 (Coding Plan, API Key, Qwen OAuth). Users following the README instructions to configure OpenRouter/Fireworks via `qwen auth` had no API Key entry point. - Add "API Key" option to the `runInteractiveAuth` menu with two sub-paths: "Alibaba Cloud ModelStudio Standard API Key" (guided flow) and "Custom API Key" (prints docs link) - Add `qwen auth api-key` yargs subcommand for direct access - Extract `createMinimalArgv` / `loadAuthConfig` helpers to eliminate duplicated CliArgs boilerplate - Extract `promptForInput` to share raw-mode stdin logic between `promptForKey` and `promptForModelIds` - Improve `showAuthStatus` to distinguish Coding Plan, Standard API Key, and generic OpenAI-compatible configurations - Align menu labels and descriptions with the interactive `/auth` dialog Closes #3413 Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com> * docs: add `qwen auth api-key` to auth subcommand tables Update documentation to reflect the new `qwen auth api-key` subcommand: - auth.md: add to subcommands table, examples, and interactive menu display - commands.md: add to CLI Auth Subcommands table - quickstart.md: add to quick-reference command table * fix(cli): restore incomplete Coding Plan warning in showAuthStatus When selectedType is USE_OPENAI and Coding Plan metadata exists but the API key is missing, show the incomplete warning instead of falling through to the generic "OpenAI-compatible" status. * refactor(cli): use endpoint constants in region selector and fix status formatting - Use ALIBABA_STANDARD_API_KEY_ENDPOINTS constants for region descriptions instead of hardcoded URLs - Restore trailing newline in showAuthStatus "no auth" command list for consistent spacing * fix(cli): determine active auth method from model config in showAuthStatus Previously showAuthStatus checked which env keys exist to determine the auth method, causing false reports when users switch providers (e.g., Coding Plan key still present after switching to Standard API Key). Now it inspects the active model's provider config (baseUrl/envKey) to determine the actual method, and validates the corresponding key exists: - Coding Plan: check via isCodingPlanConfig + CODING_PLAN_ENV_KEY - Standard API Key: check via DASHSCOPE_STANDARD_API_KEY_ENV_KEY + endpoints - Generic OpenAI-compatible: check if the model's envKey is set Also clear stale Coding Plan metadata (codingPlan.region/version and process.env) when switching to Standard API Key. * fix(cli): add legacy fallback in showAuthStatus and clear persisted Coding Plan env - When no active model config is found (legacy setups without modelProviders), fall back to env key / metadata checks for Coding Plan status detection. Fixes CI test failures. - When activeConfig exists but has no envKey, report incomplete status instead of false positive "Configured". - Clear persisted env.BAILIAN_CODING_PLAN_API_KEY from settings when switching to Standard API Key, not just process.env. * fix(cli): also remove Coding Plan model entries when switching to Standard API Key When switching to Standard API Key, filter out existing Coding Plan model entries from modelProviders.openai in addition to old Standard entries. Previously these were preserved but their credential source (BAILIAN_CODING_PLAN_API_KEY) was cleared, leaving broken model entries visible in /model. --------- Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
8.7 KiB
Quickstart
👏 Welcome to Qwen Code!
This quickstart guide will have you using AI-powered coding assistance in just a few minutes. By the end, you'll understand how to use Qwen Code for common development tasks.
Before you begin
Make sure you have:
- A terminal or command prompt open
- A code project to work with
- An API key from Alibaba Cloud Model Studio (Beijing / intl), or an Alibaba Cloud Coding Plan (Beijing / intl) subscription
Step 1: Install Qwen Code
To install Qwen Code, use one of the following methods:
Quick Install (Recommended)
Linux / macOS
curl -fsSL https://qwen-code-assets.oss-cn-hangzhou.aliyuncs.com/installation/install-qwen.sh | bash
Windows (Run as Administrator)
powershell -Command "Invoke-WebRequest 'https://qwen-code-assets.oss-cn-hangzhou.aliyuncs.com/installation/install-qwen.bat' -OutFile (Join-Path $env:TEMP 'install-qwen.bat'); & (Join-Path $env:TEMP 'install-qwen.bat')"
Note
It's recommended to restart your terminal after installation to ensure environment variables take effect.
Manual Installation
Prerequisites
Make sure you have Node.js 20 or later installed. Download it from nodejs.org.
NPM
npm install -g @qwen-code/qwen-code@latest
Homebrew (macOS, Linux)
brew install qwen-code
Step 2: Set up authentication
When you start an interactive session with the qwen command, you'll be prompted to configure authentication:
# You'll be prompted to set up authentication on first use
qwen
# Or run /auth anytime to change authentication method
/auth
Choose your preferred authentication method:
- Alibaba Cloud Coding Plan: Select
Alibaba Cloud Coding Planfor a fixed monthly fee with diverse model options. See the Coding Plan guide (intl) for setup instructions. - API Key: Select
API Key, then enter your API key from Alibaba Cloud Model Studio (Beijing / intl). See the API setup guide (Beijing / intl) for details.
⚠️ Note: Qwen OAuth was discontinued on April 15, 2026. If you were previously using Qwen OAuth, please switch to one of the methods above.
Note
When you first authenticate Qwen Code with your Qwen account, a workspace called ".qwen" is automatically created for you. This workspace provides centralized cost tracking and management for all Qwen Code usage in your organization.
Tip
You can also configure authentication directly from the terminal without starting a session by running
qwen auth. Useqwen auth statusto check your current configuration at any time. See the Authentication page for details.
Step 3: Start your first session
Open your terminal in any project directory and start Qwen Code:
# optiona
cd /path/to/your/project
# start qwen
qwen
You'll see the Qwen Code welcome screen with your session information, recent conversations, and latest updates. Type /help for available commands.
Chat with Qwen Code
Ask your first question
Qwen Code will analyze your files and provide a summary. You can also ask more specific questions:
explain the folder structure
You can also ask Qwen Code about its own capabilities:
what can Qwen Code do?
Note
Qwen Code reads your files as needed - you don't have to manually add context. Qwen Code also has access to its own documentation and can answer questions about its features and capabilities.
Make your first code change
Now let's make Qwen Code do some actual coding. Try a simple task:
add a hello world function to the main file
Qwen Code will:
- Find the appropriate file
- Show you the proposed changes
- Ask for your approval
- Make the edit
Note
Qwen Code always asks for permission before modifying files. You can approve individual changes or enable "Accept all" mode for a session.
Use Git with Qwen Code
Qwen Code makes Git operations conversational:
what files have I changed?
commit my changes with a descriptive message
You can also prompt for more complex Git operations:
create a new branch called feature/quickstart
show me the last 5 commits
help me resolve merge conflicts
Fix a bug or add a feature
Qwen Code is proficient at debugging and feature implementation.
Describe what you want in natural language:
add input validation to the user registration form
Or fix existing issues:
there's a bug where users can submit empty forms - fix it
Qwen Code will:
- Locate the relevant code
- Understand the context
- Implement a solution
- Run tests if available
Test out other common workflows
There are a number of ways to work with Qwen Code:
Refactor code
refactor the authentication module to use async/await instead of callbacks
Write tests
write unit tests for the calculator functions
Update documentation
update the README with installation instructions
Code review
review my changes and suggest improvements
Tip
Remember: Qwen Code is your AI pair programmer. Talk to it like you would a helpful colleague - describe what you want to achieve, and it will help you get there.
Essential commands
Here are the most important commands for daily use:
| Command | What it does | Example |
|---|---|---|
qwen |
start Qwen Code | qwen |
/auth |
Change authentication method (in session) | /auth |
qwen auth |
Configure authentication from the terminal | qwen auth |
qwen auth api-key |
Configure API key authentication | qwen auth api-key |
qwen auth status |
Check current authentication status | qwen auth status |
/help |
Display help information for available commands | /help or /? |
/compress |
Replace chat history with summary to save Tokens | /compress |
/clear |
Clear terminal screen content | /clear (shortcut: Ctrl+L) |
/theme |
Change Qwen Code visual theme | /theme |
/language |
View or change language settings | /language |
→ ui [language] |
Set UI interface language | /language ui zh-CN |
→ output [language] |
Set LLM output language | /language output Chinese |
/quit |
Exit Qwen Code immediately | /quit or /exit |
See the CLI reference for a complete list of commands.
Pro tips for beginners
Be specific with your requests
- Instead of: "fix the bug"
- Try: "fix the login bug where users see a blank screen after entering wrong credentials"
Use step-by-step instructions
- Break complex tasks into steps:
1. create a new database table for user profiles
2. create an API endpoint to get and update user profiles
3. build a webpage that allows users to see and edit their information
Let Qwen Code explore first
- Before making changes, let Qwen Code understand your code:
analyze the database schema
build a dashboard showing products that are most frequently returned by our UK customers
Save time with shortcuts
- Press
?to see all available keyboard shortcuts - Use Tab for command completion
- Press ↑ for command history
- Type
/to see all slash commands
Getting help
- In Qwen Code: Type
/helpor ask "how do I..." - Documentation: You're here! Browse other guides
- Community: Join our GitHub Discussion for tips and support