* docs: fix config/command/auth drift and surface model-providers page
Audit docs/ against the current code and correct the highest-impact drift:
- settings.md: move the mis-filed experimental.emitToolUseSummaries row into a
new experimental section (cron/agentTeam/artifact/emitToolUseSummaries) and
add general.language/outputLanguage/dynamicCommandTranslation and
output.showTimestamps.
- commands.md: document /cd, /history, /voice, /import-config and the
/model --voice and /model <model-id> forms.
- auth.md + model-providers.md: convert all modelProviders examples to the v5
{ protocol, models } object shape, correct the /auth menu (Alibaba
ModelStudio / Third-party Providers / Custom Provider), fix the default
OpenAI model (qwen3.5-plus), document the vertex-ai auth type, mark envKey
optional, and use kebab-case --openai-api-key/--openai-base-url flags.
- overview.md + quickstart.md: rewrite the stale first-run auth flow; fix typo.
- configuration/_meta.ts: surface the orphaned model-providers page in the nav.
- qc-helper SKILL.md: add the 8 missing feature pages to the doc index.
* docs: resolve review feedback — fix provider-name and ModelStudio casing
Align docs with the code's provider labels and UI strings:
- Z.ai -> Z.AI (presets/zai.ts: label 'Z.AI API Key')
- iDeaLab -> Idealab (presets/idealab.ts: label 'Idealab API Key')
- 'Model Studio' -> 'ModelStudio' (UI flowTitle 'Alibaba ModelStudio'; no 'Model Studio' in code)
Applied across auth.md, overview.md, quickstart.md. Used --no-verify to avoid
lint-staged reformatting pre-existing, unrelated (non-CI-enforced) table padding
in auth.md; the five changed lines are individually prettier-clean.
* docs: resolve review feedback — /history subcommands, language type, jsonc fence
- commands.md: add missing '/history expand-on-resume' subcommand (historyCommand.ts registers collapse-on-resume, expand-on-resume, expand-now)
- settings.md: general.language Type string -> enum (settingsSchema.ts declares type: 'enum')
- model-providers.md: relabel the Example fence json -> jsonc (it contains // comments and two JSON docs)
--no-verify: avoids lint-staged re-padding pre-existing, unrelated (non-CI-enforced)
table columns; the three changed lines are content-only.
8.8 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 ModelStudio (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-standalone.sh | bash
Windows
irm https://qwen-code-assets.oss-cn-hangzhou.aliyuncs.com/installation/install-qwen-standalone.ps1 | iex
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 22 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
The first-run menu lets you connect a model provider. Choose one of:
- Alibaba ModelStudio — the recommended setup. Opens a sub-menu:
- Coding Plan: for individual developers, with an included weekly quota and diverse model options. See the Coding Plan guide (intl) for setup instructions.
- Token Plan: usage-based billing with a dedicated endpoint, aimed at teams and companies.
- Standard API Key: connect with an existing API key from Alibaba Cloud ModelStudio (Beijing / intl). See the API setup guide (Beijing / intl) for details.
- Third-party Providers — choose a built-in provider (DeepSeek, MiniMax, Z.AI, ModelScope, OpenRouter, Requesty, and more) and connect with an API key.
- Custom Provider — manually connect a local server, proxy, or unsupported provider.
⚠️ 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
To configure authentication, start Qwen Code and run
/auth. Use/doctorto 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:
# optional
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 |
/doctor |
Check current authentication and environment | /doctor |
/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