abbyswag/qwen-code
1
0
Fork 0
mirror of https://github.com/QwenLM/qwen-code.git synced 2025-12-19 09:33:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update overview and common workflows, add quickstart guide

Browse Source
This commit is contained in:
joeytoday
2025-12-08 17:48:39 +08:00
parent d2ed3e73f4
commit f7b94f9b63
4 changed files with 1201 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

819
docs/users/common-workflow.md
View File

@@ -0,0 +1,819 @@
# Common workflows
> Learn about common workflows with Qwen Code.
Each task in this document includes clear instructions, example commands, and best practices to help you get the most from Qwen Code.
## Understand new codebases
### Get a quick codebase overview
Suppose you've just joined a new project and need to understand its structure quickly.
1. Navigate to the project root directory
```bash
cd /path/to/project
```
2. Start Qwen Code
```bash
qwen
```
3. Ask for a high-level overview
```
give me an overview of this codebase
```
4. Dive deeper into specific components
```
explain the main architecture patterns used here
```
```
what are the key data models?
```
```
how is authentication handled?
```
> [!tip] Tips:
>
> - Start with broad questions, then narrow down to specific areas
> - Ask about coding conventions and patterns used in the project
> - Request a glossary of project-specific terms
### Find relevant code
Suppose you need to locate code related to a specific feature or functionality.
1. Ask Qwen Code to find relevant files
```
find the files that handle user authentication
```
2. Get context on how components interact
```
how do these authentication files work together?
```
3. Understand the execution flow
```
trace the login process from front-end to database
```
> [!tip] Tips
>
> - Be specific about what you're looking for
> - Use domain language from the project
## Fix bugs efficiently
Suppose you've encountered an error message and need to find and fix its source.
1. Share the error with Qwen Code
```
I'm seeing an error when I run npm test
```
2. Ask for fix recommendations
```
suggest a few ways to fix the @ts-ignore in user. ts
```
3. Apply the fix
```
update user. ts to add the null check you suggested
```
> [!tip] Tips:
>
> - Tell Qwen Code the command to reproduce the issue and get a stack trace
> - Mention any steps to reproduce the error
> - Let Qwen Code know if the error is intermittent or consistent
## Refactor code
Suppose you need to update old code to use modern patterns and practices.
1. Identify legacy code for refactoring
```
find deprecated API usage in our codebase
```
2. Get refactoring recommendations
```
suggest how to refactor utils.js to use modern JavaScript features
```
3. Apply the changes safely
```
refactor utils.js to use ES 2024 features while maintaining the same behavior
```
4. Verify the refactoring
```
run tests for the refactored code
```
> [!tip] Tips:
>
> - Ask Qwen Code to explain the benefits of the modern approach
> - Request that changes maintain backward compatibility when needed
> - Do refactoring in small, testable increments
## Use specialized subagents
Suppose you want to use specialized AI subagents to handle specific tasks more effectively.
1. View available subagents
```
/agents
```
This shows all available subagents and lets you create new ones.
2. Use subagents automatically
Qwen Code automatically delegates appropriate tasks to specialized subagents:
```
review my recent code changes for security issues
```
```
run all tests and fix any failures
```
3. Explicitly request specific subagents
```
use the code-reviewer subagent to check the auth module
```
```
have the debugger subagent investigate why users can't log in
```
4. Create custom subagents for your workflow
```
/agents
```
Then select "Create New subagent" and follow the prompts to define:
- A unique identifier that describes the subagent's purpose (for example, `code-reviewer`, `api-designer`).
- When Qwen Code should use this agent
- Which tools it can access
- A system prompt describing the agent's role and behavior
> [!tip] Tips:
>
> - Create project-specific subagents in `.qwen-code/agents/` for team sharing
> - Use descriptive `description` fields to enable automatic delegation
> - Limit tool access to what each subagent actually needs
> - Check the [subagents documentation](/sub-agents) for detailed examples
## Use Plan Mode for safe code analysis
Plan Mode instructs Claude to create a plan by analyzing the codebase with read-only operations, perfect for exploring codebases, planning complex changes, or reviewing code safely.
### When to use Plan Mode
- **Multi-step implementation**: When your feature requires making edits to many files
- **Code exploration**: When you want to research the codebase thoroughly before changing anything
- **Interactive development**: When you want to iterate on the direction with Qwen Code
### How to use Plan Mode
**Turn on Plan Mode during a session**
You can switch into Plan Mode during a session using **Shift+Tab** to cycle through permission modes.
If you are in Normal Mode, **Shift+Tab** first switches into Auto-Accept Mode, indicated by `⏵⏵ accept edits on` at the bottom of the terminal. A subsequent **Shift+Tab** will switch into Plan Mode, indicated by `⏸ plan mode`.
**Start a new session in Plan Mode**
To start a new session in Plan Mode, use the `/approval-mode` then select `plan`
```bash
/approval-mode
```
**Run "headless" queries in Plan Mode**
You can also run a query in Plan Mode directly with `-p` (that is, in ["headless mode"](/en/headless)):
```bash
/approval-mode plan -p "Analyze the authentication system and suggest improvements"
```
### Example: Planning a complex refactor
```bash
/approval-mode plan
```
```
I need to refactor our authentication system to use OAuth2. Create a detailed migration plan.
```
Qwen Code analyzes the current implementation and create a comprehensive plan. Refine with follow-ups:
```
What about backward compatibility?
How should we handle database migration?
```
### Configure Plan Mode as default
```json
// .qwen-code/settings.json
{
"permissions": {
"defaultMode": "plan"
}
}
```
See [settings documentation](/en/settings#available-settings) for more configuration options.
## Work with tests
Suppose you need to add tests for uncovered code.
1. Identify untested code
```
find functions in NotificationsService. swift that are not covered by tests
```
2. Generate test scaffolding
```
add tests for the notification service
```
3. Add meaningful test cases
```
add test cases for edge conditions in the notification service
```
4. Run and verify tests
```
run the new tests and fix any failures
```
Qwen Code can generate tests that follow your project's existing patterns and conventions. When asking for tests, be specific about what behavior you want to verify. Qwen Code examines your existing test files to match the style, frameworks, and assertion patterns already in use.
For comprehensive coverage, ask Qwen Code to identify edge cases you might have missed. Qwen Code can analyze your code paths and suggest tests for error conditions, boundary values, and unexpected inputs that are easy to overlook.
## Create pull requests
Suppose you need to create a well-documented pull request for your changes.
1. Summarize your changes
```
summarize the changes I've made to the authentication module
```
2. Generate a pull request with Qwen Code
```
create a pr
```
3. Review and refine
```
enhance the PR description with more context about the security improvements
```
4. Add testing details
```
add information about how these changes were tested
```
> [!tip] Tips:
>
> - Ask Qwen Code directly to make a PR for you
> - Review Qwen Code's generated PR before submitting
> - Ask Qwen Code to highlight potential risks or considerations
## Handle documentation
Suppose you need to add or update documentation for your code.
1. Identify undocumented code
```
find functions without proper JSDoc comments in the auth module
```
2. Generate documentation
```
add JSDoc comments to the undocumented functions in auth.js
```
3. Review and enhance
```
improve the generated documentation with more context and examples
```
4. Verify documentation
```
> check if the documentation follows our project standards
```
> [!tip] Tips:
>
> - Specify the documentation style you want (JSDoc, docstrings, etc.)
> - Ask for examples in the documentation
> - Request documentation for public APIs, interfaces, and complex logic
## Work with images
Suppose you need to work with images in your codebase, and you want Qwen Code's help analyzing image content.
1. Add an image to the conversation
You can use any of these methods:
1) Drag and drop an image into the Qwen Code window
2) Copy an image and paste it into the CLI with ctrl+v (Do not use cmd+v)
3) Provide an image path to Claude. E.g., "Analyze this image: /path/to/your/image. png"
3. Ask Claude to analyze the image
```
What does this image show?
```
```
Describe the UI elements in this screenshot
```
```
Are there any problematic elements in this diagram?
```
3. Use images for context
```
Here's a screenshot of the error. What's causing it?
```
```
This is our current database schema. How should we modify it for the new feature?
```
4. Get code suggestions from visual content
```
Generate CSS to match this design mockup
```
```
What HTML structure would recreate this component?
```
> [!tip] Tips:
>
> - Use images when text descriptions would be unclear or cumbersome
> - Include screenshots of errors, UI designs, or diagrams for better context
> - You can work with multiple images in a conversation
> - Image analysis works with diagrams, screenshots, mockups, and more
## Reference files and directories
Use `@` to quickly include files or directories without waiting for Qwen Code to read them.
1. Reference a single file
```
Explain the logic in @src/utils/auth.js
```
This includes the full content of the file in the conversation.
2. Reference a directory
```
What's the structure of @src/components?
```
This provides a directory listing with file information.
3. Reference MCP resources
```
Show me the data from @github: repos/owner/repo/issues
```
This fetches data from connected MCP servers using the format @server: resource. See [MCP resources](/en/mcp#use-mcp-resources) for details.
> [!tip] Tips:
>
> - File paths can be relative or absolute
> - @ file references add `QWEN.md` in the file's directory and parent directories to context
> - Directory references show file listings, not contents
> - You can reference multiple files in a single message (for example, "`@file 1.js` and `@file 2.js`")
## Use extended thinking
Suppose you're working on complex architectural decisions, challenging bugs, or planning multi-step implementations that require deep reasoning.
> [!note]
>
> [Extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) is disabled by default in Qwen Code. You can enable it on-demand by using `Tab` to toggle Thinking on, or by using prompts like "think" or "think hard". You can also enable it permanently by setting the [`MAX_THINKING_TOKENS` environment variable](/en/settings#environment-variables) in your settings.
1. Provide context and ask Qwen Code to think
```
I need to implement a new authentication system using OAuth 2 for our API. Think deeply about the best approach for implementing this in our codebase.
```
Qwen Code gathers relevant information from your codebase and uses extended thinking, which is visible in the interface.
2. Refine the thinking with follow-up prompts
```
think about potential security vulnerabilities in this approach
```
```
think hard about edge cases we should handle
```
> [!tip]
> Tips to get the most value out of extended thinking:
>
> [Extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) is most valuable for complex tasks such as:
>
> - Planning complex architectural changes
> - Debugging intricate issues
> - Creating implementation plans for new features
> - Understanding complex codebases
> - Evaluating tradeoffs between different approaches
>
> Use `Tab` to toggle Thinking on and off during a session.
>
> The way you prompt for thinking results in varying levels of thinking depth:
>
> - "think" triggers basic extended thinking
> - intensifying phrases such as "keep hard", "think more", "think a lot", or "think longer" triggers deeper thinking
>
> For more extended thinking prompting tips, see [Extended thinking tips](https://docs.claude.com/en/docs/build-with-claude/prompt-engineering/extended-thinking-tips).
> [!note]
> Qwen Code displays its thinking process as italic gray text above the response.
## Resume previous conversations
Suppose you've been working on a task with Qwen Code and need to continue where you left off in a later session.
Qwen Code provides two options for resuming previous conversations:
- `--continue` to automatically continue the most recent conversation
- `--resume` to display a conversation picker
1. Continue the most recent conversation
```bash
qwen-code --continue
```
This immediately resumes your most recent conversation without any prompts.
2. Continue in non-interactive mode
```bash
qwen-code --continue --print "Continue with my task"
```
Use `--print` with `--continue` to resume the most recent conversation in non-interactive mode, perfect for scripts or automation.
3. Show conversation picker
```bash
qwen-code --resume
```
This displays an interactive conversation selector with a clean list view showing:
- Session summary (or initial prompt)
- Metadata: time elapsed, message count, and git branch
Use arrow keys to navigate and press Enter to select a conversation. Press Esc to exit.
> [!tip] Tips:
>
> - Conversation history is stored locally on your machine
> - Use `--continue` for quick access to your most recent conversation
> - Use `--resume` when you need to select a specific past conversation
> - When resuming, you'll see the entire conversation history before continuing
> - The resumed conversation starts with the same model and configuration as the original
>
> How it works:
>
> 1. **Conversation Storage**: All conversations are automatically saved locally with their full message history
> 2. **Message Deserialization**: When resuming, the entire message history is restored to maintain context
> 3. **Tool State**: Tool usage and results from the previous conversation are preserved
> 4. **Context Restoration**: The conversation resumes with all previous context intact
>
> Examples:
>
> ```bash
> # Continue most recent conversation
> qwen-code --continue
>
> # Continue most recent conversation with a specific prompt
> qwen-code --continue --print "Show me our progress"
>
> # Show conversation picker
> qwen-code --resume
>
> # Continue most recent conversation in non-interactive mode
> qwen-code --continue --print "Run the tests again"
> ```
## Run parallel Qwen Code sessions with Git worktrees
Suppose you need to work on multiple tasks simultaneously with complete code isolation between Qwen Code instances.
1. Understand Git worktrees
Git worktrees allow you to check out multiple branches from the same repository into separate directories. Each worktree has its own working directory with isolated files, while sharing the same Git history. Learn more in the [official Git worktree documentation]( https://git-scm.com/docs/git-worktree ).
2. Create a new worktree
```bash
# Create a new worktree with a new branch
git worktree add ../project-feature-a -b feature-a
# Or create a worktree with an existing branch
git worktree add ../project-bugfix bugfix-123
```
This creates a new directory with a separate working copy of your repository.
4. Run Qwen Code in each worktree
```bash
# Navigate to your worktree
cd ../project-feature-a
# Run Qwen Code in this isolated environment
qwen
```
5. Run Claude in another worktree
```bash
cd ../project-bugfix
qwen
```
6. Manage your worktrees
```bash
# List all worktrees
git worktree list
# Remove a worktree when done
git worktree remove ../project-feature-a
```
> [!tip] Tips:
>
> - Each worktree has its own independent file state, making it perfect for parallel Qwen Code sessions
> - Changes made in one worktree won't affect others, preventing Claude instances from interfering with each other
> - All worktrees share the same Git history and remote connections
> - For long-running tasks, you can have Qwen Code working in one worktree while you continue development in another
> - Use descriptive directory names to easily identify which task each worktree is for
> - Remember to initialize your development environment in each new worktree according to your project's setup. Depending on your stack, this might include:
> - JavaScript projects: Running dependency installation (`npm install`, `yarn`)
> - Python projects: Setting up virtual environments or installing with package managers
> - Other languages: Following your project's standard setup process
## Use Claude as a unix-style utility
### Add Claude to your verification process
Suppose you want to use Qwen Code as a linter or code reviewer.
**Add Qwen Code to your build script:**
```json
// package.json
{
...
"scripts": {
...
"lint:Qwen Code": "qwen-code -p 'you are a linter. please look at the changes vs. main and report any issues related to typos. report the filename and line number on one line, and a description of the issue on the second line. do not return any other text.'"
}
}
```
> [!tip] Tips:
>
> - Use Qwen Code for automated code review in your CI/CD pipeline
> - Customize the prompt to check for specific issues relevant to your project
> - Consider creating multiple scripts for different types of verification
### Pipe in, pipe out
Suppose you want to pipe data into Qwen Code, and get back data in a structured format.
**Pipe data through Claude:**
```bash
cat build-error.txt | qwen-code -p 'concisely explain the root cause of this build error' > output.txt
```
> [!tip] Tips:
>
> - Use pipes to integrate Qwen-Code into existing shell scripts
> - Combine with other Unix tools for powerful workflows
> - Consider using --output-format for structured output
### Control output format
Suppose you need Qwen Code's output in a specific format, especially when integrating Qwen Code into scripts or other tools.
1. Use text format (default)
```bash
cat data. txt | qwen-code -p 'summarize this data' --output-format text > summary. txt
```
This outputs just Qwen Code's plain text response (default behavior).
2. Use JSON format
```bash
cat code. py | qwen-code -p 'analyze this code for bugs' --output-format json > analysis.json
```
This outputs a JSON array of messages with metadata including cost and duration.
3. Use streaming JSON format
```bash
cat log. txt | qwen-code -p 'parse this log file for errors' --output-format stream-json
```
This outputs a series of JSON objects in real-time as Qwen Code processes the request. Each message is a valid JSON object, but the entire output is not valid JSON if concatenated.
> [!tip] Tips:
>
> - Use `--output-format text` for simple integrations where you just need Claude's response
> - Use `--output-format json` when you need the full conversation log
> - Use `--output-format stream-json` for real-time output of each conversation turn
## Create custom slash commands
Qwen Code supports custom slash commands that you can create to quickly execute specific prompts or tasks.
For more details, see the [Slash commands](/en/slash-commands) reference page.
### Create project-specific commands
Suppose you want to create reusable slash commands for your project that all team members can use.
1. Create a commands directory in your project
```bash
mkdir -p .qwen-code/commands
```
2. Create a Markdown file for each command
```bash
echo "Analyze the performance of this code and suggest three specific optimizations: " > .qwen-code/commands/optimize.md
```
3. Use your custom command in Qwen Code
```
> /optimize
```
> [!tip] Tips:
>
> - Command names are derived from the filename (for example, `optimize.md` becomes `/optimize`)
> - You can organize commands in subdirectories (for example, `.qwen-code/commands/frontend/component.md` creates `/component` with " (project:frontend)" shown in the description)
> - Project commands are available to everyone who clones the repository
> - The Markdown file content becomes the prompt sent to Claude when the command is invoked
### Add command arguments with \$ARGUMENTS
Suppose you want to create flexible slash commands that can accept additional input from users.
1. Create a command file with the $ARGUMENTS placeholder
```bash
echo 'Find and fix issue #$ARGUMENTS. Follow these steps:
1.Understand the issue described in the ticket
2. Locate the relevant code in
our codebase
3. Implement a solution that addresses the root cause
4. Add
appropriate tests
5. Prepare a concise PR description' >
.qwen-code/commands/fix-issue.md
```
2. Use the command with an issue number
In your Claude session, use the command with arguments.
```
> /fix-issue 123
```
This replaces \$ARGUMENTS with "123" in the prompt.
> [!tip] Tips:
>
> - The \$ARGUMENTS placeholder is replaced with any text that follows the command
> - You can position \$ARGUMENTS anywhere in your command template
> - Other useful applications: generating test cases for specific functions, creating documentation for components, reviewing code in particular files, or translating content to specified languages
### Create personal slash commands
Suppose you want to create personal slash commands that work across all your projects.
1. Create a commands directory in your home folder
```bash
mkdir -p ~/.qwen-code/commands
```
2. Create a Markdown file for each command
```bash
echo "Review this code for security vulnerabilities, focusing on: " >
~/.qwen-code/commands/security-review.md
```
3. Use your personal custom command
```
> /security-review
```
> [!tip] Tips:
>
> - Personal commands show " (user)" in their description when listed with `/help`
> - Personal commands are only available to you and not shared with your team
> - Personal commands work across all your projects
> - You can use these for consistent workflows across different codebases
## Ask Qwen Code about its capabilities
Qwen Code has built-in access to its documentation and can answer questions about its own features and limitations.
### Example questions
```
can Qwen Code create pull requests?
```
```
how does Qwen Code handle permissions?
```
```
what slash commands are available?
```
```
how do I use MCP with Qwen Code?
```
```
how do I configure Qwen Code for Amazon Bedrock?
```
```
what are the limitations of Qwen Code?
```
> [!note]
>
> Qwen Code provides documentation-based answers to these questions. For executable examples and hands-on demonstrations, refer to the specific workflow sections above.
> [!tip] Tips:
>
> - Qwen Code always has access to the latest Qwen Code documentation, regardless of the version you're using
> - Ask specific questions to get detailed answers
> - Qwen Code can explain complex features like MCP integration, enterprise configurations, and advanced workflows
## Next steps
<Card title="Qwen Code reference implementation" icon="code" href="https://github.com/anthropics/claude-code/tree/main/.devcontainer
Clone our development container reference implementation.
</Card>

139
docs/users/overview.md
View File

@@ -1,110 +1,116 @@
# Qwen Code overview
> Learn about Qwen Code, Anthropic's agentic coding tool that lives in your terminal and helps you turn ideas into code faster than ever before.
> Learn about Qwen Code, Qwen's agentic coding tool that lives in your terminal and helps you turn ideas into code faster than ever before.
## Get started in 30 seconds
Prerequisites:
* A [Claude.ai](https://claude.ai) (recommended) or [Claude Console](https://console.anthropic.com/) account
- A [Qwen Code](https://chat.qwen.ai/auth?mode=register) account
- Requires [Node.js 20+](https://nodejs.org/download), you can use `node -v` check the version. If it's not installed, use the following command to install it.
**Install Qwen Code:**
<Tabs>
<Tab title="macOS/Linux">
```bash theme={null}
curl -fsSL https://claude.ai/install.sh | bash
```q
</Tab>
<Tab title="Homebrew">
```bash theme={null}
brew install --cask claude-code
```
</Tab>
<Tab title="Windows">
```powershell theme={null}
irm https://claude.ai/install.ps1 | iex
```
</Tab>
<Tab title="NPM">
```bash theme={null}
npm install -g @anthropic-ai/claude-code
```
Requires [Node.js 18+](https://nodejs.org/en/download/)
</Tab>
</Tabs>
**Start using Qwen Code:**
```bash theme={null}
cd your-project
claude
```bash
curl -qL https://www.npmjs.com/install.sh | sh
```
You'll be prompted to log in on first use. That's it! [Continue with Quickstart (5 mins) →](/en/quickstart)
### Install Qwen Code:
<Tip>
See [advanced setup](/en/setup) for installation options or [troubleshooting](/en/troubleshooting) if you hit issues.
</Tip>
**NPM**(recommended)
<Note>
**New VS Code Extension (Beta)**: Prefer a graphical interface? Our new [VS Code extension](/en/vs-code) provides an easy-to-use native IDE experience without requiring terminal familiarity. Simply install from the marketplace and start coding with Claude directly in your sidebar.
</Note>
```bash
npm install -g @qwen-code/qwen-code@latest
```
**Homebrew**
```bash
brew install qwen-code
```
**GitHub**
```bash
# clone GitHub project
git clone https://github.com/QwenLM/qwen-code.git
# go to qwen-code folder
cd qwen-code
# install npm
npm install
# install qwen-code
npm install -g @qwen-code/qwen-code@latest
```
### Start using Qwen Code:
```bash
cd your-project
qwen
```
You'll be prompted to log in on first use. That's it! [Continue with Quickstart (5 mins) →](/quickstart)
> [!tip]
>
> See [advanced setup](/setup) for installation options or [troubleshooting](/troubleshooting) if you hit issues.
> [!note]
>
> **New VS Code Extension (Beta)**: Prefer a graphical interface? Our new [VS Code extension](/vs-code) provides an easy-to-use native IDE experience without requiring terminal familiarity. Simply install from the marketplace and start coding with Qwen Code directly in your sidebar.
## What Qwen Code does for you
* **Build features from descriptions**: Tell Claude what you want to build in plain English. It will make a plan, write the code, and ensure it works.
* **Build features from descriptions**: Tell Qwen Code what you want to build in plain language. It will make a plan, write the code, and ensure it works.
* **Debug and fix issues**: Describe a bug or paste an error message. Qwen Code will analyze your codebase, identify the problem, and implement a fix.
* **Navigate any codebase**: Ask anything about your team's codebase, and get a thoughtful answer back. Qwen Code maintains awareness of your entire project structure, can find up-to-date information from the web, and with [MCP](/en/mcp) can pull from external datasources like Google Drive, Figma, and Slack.
* **Navigate any codebase**: Ask anything about your team's codebase, and get a thoughtful answer back. Qwen Code maintains awareness of your entire project structure, can find up-to-date information from the web, and with [MCP](/mcp) can pull from external datasources like Google Drive, Figma, and Slack.
* **Automate tedious tasks**: Fix fiddly lint issues, resolve merge conflicts, and write release notes. Do all this in a single command from your developer machines, or automatically in CI.
## Why developers love Qwen Code
* **Works in your terminal**: Not another chat window. Not another IDE. Qwen Code meets you where you already work, with the tools you already love.
* **Takes action**: Qwen Code can directly edit files, run commands, and create commits. Need more? [MCP](/en/mcp) lets Claude read your design docs in Google Drive, update your tickets in Jira, or use *your* custom developer tooling.
* **Unix philosophy**: Qwen Code is composable and scriptable. `tail -f app.log | claude -p "Slack me if you see any anomalies appear in this log stream"` *works*. Your CI can run `claude -p "If there are new text strings, translate them into French and raise a PR for @lang-fr-team to review"`.
* **Enterprise-ready**: Use the Claude API, or host on AWS or GCP. Enterprise-grade [security](/en/security), [privacy](/en/data-usage), and [compliance](https://trust.anthropic.com/) is built-in.
* **Takes action**: Qwen Code can directly edit files, run commands, and create commits. Need more? [MCP](/mcp) lets Qwen Code read your design docs in Google Drive, update your tickets in Jira, or use *your* custom developer tooling.
* **Unix philosophy**: Qwen Code is composable and scriptable. `tail -f app.log | qwen -p "Slack me if you see any anomalies appear in this log stream"` *works*. Your CI can run `qwen -p "If there are new text strings, translate them into French and raise a PR for @lang-fr-team to review"`.
* **Enterprise-ready**: Use the Qwen Code API, or host on AWS or GCP. Enterprise-grade [security](/security) and [Terms of Service](https://qwenlm.github.io/qwen-code-docs/support/tos-privacy/) is built-in.
## Next steps
<CardGroup>
<Card title="Quickstart" icon="rocket" href="/en/quickstart">
<Card title="Quickstart" icon="rocket" href="/quickstart">
See Qwen Code in action with practical examples
</Card>
<Card title="Common workflows" icon="graduation-cap" href="/en/common-workflows">
</Card>
<Card title="Common workflows" icon="graduation-cap" href="/common-workflows">
Step-by-step guides for common workflows
</Card>
<Card title="Troubleshooting" icon="wrench" href="/en/troubleshooting">
</Card>
<Card title="Troubleshooting" icon="wrench" href="/troubleshooting">
Solutions for common issues with Qwen Code
</Card>
</Card>
<Card title="IDE setup" icon="laptop" href="/en/vs-code">
<Card title="IDE setup" icon="laptop" href="/vs-code">
Add Qwen Code to your IDE
</Card>
</CardGroup>
## Additional resources
<CardGroup>
<Card title="Build with the Agent SDK" icon="code-branch" href="https://docs.claude.com/en/docs/agent-sdk/overview">
<Card title="Build with the Agent SDK" icon="code-branch" href="https://docs.claude.com/docs/agent-sdk/overview">
Create custom AI agents with the Claude Agent SDK
</Card>
<Card title="Host on AWS or GCP" icon="cloud" href="/en/third-party-integrations">
<Card title="Host on AWS or GCP" icon="cloud" href="/third-party-integrations">
Configure Qwen Code with Amazon Bedrock or Google Vertex AI
</Card>
<Card title="Settings" icon="gear" href="/en/settings">
<Card title="Settings" icon="gear" href="/settings">
Customize Qwen Code for your workflow
</Card>
<Card title="Commands" icon="terminal" href="/en/cli-reference">
<Card title="Commands" icon="terminal" href="/cli-reference">
Learn about CLI commands and controls
</Card>
@@ -112,16 +118,11 @@ You'll be prompted to log in on first use. That's it! [Continue with Quickstart
Clone our development container reference implementation
</Card>
<Card title="Security" icon="shield" href="/en/security">
<Card title="Security" icon="shield" href="/security">
Discover Qwen Code's safeguards and best practices for safe usage
</Card>
<Card title="Privacy and data usage" icon="lock" href="/en/data-usage">
<Card title="Privacy and data usage" icon="lock" href="/data-usage">
Understand how Qwen Code handles your data
</Card>
</CardGroup>
---
> To find navigation and other pages in this documentation, fetch the llms.txt file at: https://code.claude.com/docs/llms.txt

0
docs/users/quick-start.md
View File

312
docs/users/quickstart.md Normal file
View File

@@ -0,0 +1,312 @@
# 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
- A [Qwen Code](https://chat.qwen.ai/auth?mode=register) account
## Step 1: Install Qwen Code
To install Qwen Code, use one of the following methods:
### NPM(recommended)
Requires [Node.js 20+](https://nodejs.org/download), you can use `node -v` check the version. If it's not installed, use the following command to install it.
```bash
curl -qL https://www.npmjs.com/install.sh | sh
```
If you have [Node.js or newer installed](https://nodejs.org/en/download/):
```sh
npm install -g @qwen-code/qwen-code@latest
```
### Homebrew (macOS, Linux)
```sh
brew install qwen-code
```
### GitHub
```sh
# clone GitHub project
git clone https://github.com/QwenLM/qwen-code.git
# go to qwen-code folder
cd qwen-code
# install npm
npm install
# install qwen-code
npm install -g @qwen-code/qwen-code@latest
```
## Step 2: Log in to your account
Qwen Code requires an account to use. When you start an interactive session with the `qwen` command, you'll need to log in:
```bash
# You'll be prompted to log in on first use
qwen
```
```bash
# Follow the prompts to log in with your account
/auth
```
Select `Qwen OAuth`, log in to your account and follow the prompts to confirm. Once logged in, your credentials are stored and you won't need to log in again.
> [!note]
>
> When you first authenticate Qwen Code with your Qwen account, a workspace called "qwen-code" is automatically created for you. This workspace provides centralized cost tracking and management for all Qwen Code usage in your organization.
> [!tip]
>
> If you need to log in again or switch accounts, use the `/auth` command within Qwen Code.
## 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 or `/resume` to continue a previous conversation.
![](https://img.alicdn.com/imgextra/i3/O1CN01PwceZB1esA42wuQQH_!!6000000003926-2-tps-2104-1592.png)
> [!caution]
>
> After logging in (Step 2), your credentials are stored on your system. If you need OpenAI API authentication, you can refer to [Authentication](/authentication).
## Chat with Qwen Code
### Ask your first question
Let's start with understanding your codebase. Try one of these commands:
```
what does this project do?
```
Qwen Code will analyze your files and provide a summary. You can also ask more specific questions:
```
what technologies does this project use?
```
```
where is the main entry point?
```
```
explain the folder structure
```
You can also ask Qwen Code about its own capabilities:
```
what can Qwen Code do?
```
```
how do I use slash commands in Qwen Code?
```
```
can Qwen Code work with Docker?
```
> [!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 Claude:
**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 interactive mode | `qwen` |
| `qwen-code "task"` | Run a one-time task | `qwen-code "fix the build error"` |
| `qwen-code -p "query"` | Run one-off query, then exit | `qwen-code -p "explain this function"` |
| `qwen-code -c` | Continue most recent conversation | `qwen-code -c` |
| `qwen-code -r` | Resume a previous conversation | `qwen-code -r` |
| `qwen-code commit` | Create a Git commit | `qwen-code commit` |
| `/clear` | Clear conversation history | `/clear` |
| `/help` | Show available commands | `/help` |
| `quit` or Ctrl+C | Exit Qwen Code | `/quit` |
See the [CLI reference](/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 Claude explore first
- Before making changes, let Claude 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
## What's next?
Now that you've learned the basics, explore more advanced features:
<CardGroup cols={3}>
<Card title="Common workflows" icon="graduation-cap" href="/en/common-workflows">
Step-by-step guides for common tasks
</Card>
<Card title="CLI reference" icon="terminal" href="/en/cli-reference">
Master all commands and options
</Card>
<Card title="Configuration" icon="gear" href="/en/settings">
Customize Qwen Code for your workflow
</Card>
<Card title="Qwen Code on the web" icon="cloud" href="/en/claude-code-on-the-web">
Run tasks asynchronously in the cloud
</Card>
</CardGroup>
## Getting help
- **In Qwen Code**: Type `/help` or ask "how do I..."
- **Documentation**: You're here! Browse other guides
- **Community**: Join our [GitHub Discussion](https://github.com/QwenLM/qwen-code/discussions) for tips and support