docs/users/quickstart.md
👏 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.
Make sure you have:
To install Qwen Code, use one of the following methods:
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.
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
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 for a fixed monthly fee with diverse model options. See the Coding Plan guide (intl) for setup instructions.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.
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.
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.
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:
[!note]
Qwen Code always asks for permission before modifying files. You can approve individual changes or enable "Accept all" mode for a session.
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
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:
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.
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.
Be specific with your requests
Use step-by-step instructions
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
analyze the database schema
build a dashboard showing products that are most frequently returned by our UK customers
Save time with shortcuts
? to see all available keyboard shortcuts/ to see all slash commands/help or ask "how do I..."