Back to Qwen Code

Quickstart

docs/users/quickstart.md

0.15.68.7 KB
Original Source

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:

Linux / macOS

sh
curl -fsSL https://qwen-code-assets.oss-cn-hangzhou.aliyuncs.com/installation/install-qwen.sh | bash

Windows (Run as Administrator)

cmd
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

bash
npm install -g @qwen-code/qwen-code@latest

Homebrew (macOS, Linux)

bash
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:

bash
# You'll be prompted to set up authentication on first use
qwen
bash
# Or run /auth anytime to change authentication method
/auth

Choose your preferred authentication method:

  • Alibaba Cloud Coding Plan: Select Alibaba Cloud Coding Plan for 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. Use qwen auth status to 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:

bash
# 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:

  1. Find the appropriate file
  2. Show you the proposed changes
  3. Ask for your approval
  4. 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:

CommandWhat it doesExample
qwenstart Qwen Codeqwen
/authChange authentication method (in session)/auth
qwen authConfigure authentication from the terminalqwen auth
qwen auth api-keyConfigure API key authenticationqwen auth api-key
qwen auth statusCheck current authentication statusqwen auth status
/helpDisplay help information for available commands/help or /?
/compressReplace chat history with summary to save Tokens/compress
/clearClear terminal screen content/clear (shortcut: Ctrl+L)
/themeChange Qwen Code visual theme/theme
/languageView or change language settings/language
ui [language]Set UI interface language/language ui zh-CN
output [language]Set LLM output language/language output Chinese
/quitExit 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 /help or ask "how do I..."
  • Documentation: You're here! Browse other guides
  • Community: Join our GitHub Discussion for tips and support