mirror of
https://github.com/QwenLM/qwen-code.git
synced 2026-07-26 17:34:46 +00:00
docs: add vertex-ai auth, missing commands, and qc-helper index entries (#5727)
* docs: add CLI subcommands section with qwen sessions list
- Add section 5 to commands.md for CLI-level subcommands
- Document qwen sessions list with --json and --limit flags
- Include output format, examples, and usage patterns
The sessions list command was added in commit 14e6ae8c2 but not documented.
* docs: add vertex-ai auth, missing commands, and qc-helper index entries
Audit docs/ against current codebase and fix high-impact drift:
- Add vertex-ai to auth.md, model-providers.md, and tos-privacy.md supported
auth type tables (was missing from all three)
- Add missing slash commands to commands.md: /cd, /import-config, /workflows
- Add /doctor subcommands (memory, cpu-profile, rollback) and /extensions
subcommands (list, manage, explore, install) to commands.md
- Add undocumented altNames: /clear→/reset,/new; /stats→/usage;
/auth→/connect,/login; /resume→/continue; /compress→/summarize
- Add 8 missing feature entries to qc-helper SKILL.md topic index:
code-review, followup-suggestions, tool-use-summaries, markdown-rendering,
structured-output, dual-output, channels, tips
- Fix CLI binary name in contributing.md (qwen-code → qwen)
* docs: resolve review feedback on auth count, /workflows usage, GOOGLE_MODEL example
- auth.md: correct intro count from 'four' to 'three' methods (3 bullets + 3 Options; Vertex AI is a provider under API Key)
- commands.md: add '/workflows <runId>' to usage column to match argumentHint '[runId]'
- model-providers.md: add required GOOGLE_MODEL to the Vertex AI env example so it matches the prose and modelConfigUtils requirement
* docs: remove duplicate /workflows row introduced by main merge
main already documents /workflows (with the <runId> usage); the branch
merge kept both rows, leaving a duplicate in the Tool and Model
Management table. Drop the redundant row added by this PR.
* docs: resolve review feedback — /extensions explore source arg, CLI-name remnants
- commands.md: /extensions explore requires a <source> (exploreAction errors 'Unknown extensions source' without it)
- contributing.md: finish the qwen-code -> qwen CLI rename on the debug note (binary + .qwen config dir); repo-name references left intact
* docs: resolve review feedback — Vertex AI in tos-privacy, /doctor rollback clarity
- tos-privacy.md: propagate Vertex AI (which the header already counts as the 4th method) into the Data Collection list, FAQ Q1 and Q3, and add a '4. If you are using Vertex AI' section pointing to Google Cloud terms — fixes the four-vs-three internal inconsistency
- commands.md: clarify /doctor rollback rolls back the standalone CLI binary (standalone installs only) and disambiguate from /rewind's rollback alias (doctorCommand.ts gates on isStandalone)
* docs: resolve review feedback — clear semantics, doctor argHints, arrow spacing
- /clear: fix description to 'Clear conversation history and free up context' and drop the misleading '(shortcut: Ctrl+L)' grouping; Ctrl+L only clears the screen (clearScreen), it does not reset the session like /clear (clearCommand.ts)
- Ctrl/cmd+L keyboard row: clarify it clears the visible screen only, not 'Equivalent to /clear'
- /doctor memory and /doctor cpu-profile: surface the full argumentHints ([--sample] [--snapshot], [--duration <seconds>]) from doctorCommand.ts
- normalize section 1.4 arrow subcommands to spaced '→ ' style (approval-mode rows were the lone outliers)
* docs: resolve review feedback — enumerate /extensions explore sources
List the two valid sources (Gemini, ClaudeCode) from EXTENSION_EXPLORE_URL in extensionsCommand.ts so users can discover them without trial and error.
* docs: resolve review feedback — add extensions install security warning
/extensions install (extensionsCommand.ts) installs arbitrary git repos/paths with no confirmation prompt; add a warning that extensions run with full Qwen Code permissions and should only come from trusted sources.
* docs: resolve review feedback — add /stats subcommands, /auth aliases in 1.11
- commands.md: add /stats daily, /stats monthly, /stats export rows (registered in statsCommand.ts with day/month aliases and --format csv|json)
- section 1.11: note /auth's /connect and /login aliases (parallel to section 1.4)
* docs: resolve review feedback — /stats export full args, /summarize note
- /stats export: show the full argumentHint ([date|month] and [--output path]) from statsCommand.ts
- add a note disambiguating /summarize (alias of /compress, destructive) from /summary (project summary)
* docs: resolve review feedback — complete /arena /ide /directory /voice /mcp usage
Add the missing subcommands/arguments shown in the command sources:
- /arena: stop, select (arenaCommand.ts)
- /ide: enable, disable (ideCommand.ts)
- /directory: show (directoryCommand.tsx)
- /voice: hold, tap, off (voice-command.ts argumentHint)
- /mcp: nodesc, schema, auth, noauth (mcpCommand.ts argumentHint)
* docs: resolve review feedback — arena/stats aliases, trim /stats description
- /arena select: note alias 'choose' (arenaCommand.ts)
- /stats daily, /stats monthly: label day/month as aliases (statsCommand.ts)
- /stats: trim the description to a terse behavior-focused line (drop volatile tab names/keyboard shortcuts that belong in the dashboard help)
* docs: resolve review feedback — /copy args, /doctor memory --snapshot warning
- /copy: document language/latex/mermaid/index selection (copyCommand.ts argumentHint)
- add a warning that /doctor memory --snapshot writes a heap snapshot with sensitive data (matches doctorCommand.ts runtime warning)
* docs: resolve review feedback — mcp/approval-mode/copy accuracy, qwen privacy URL
- /mcp: drop deprecated auth/noauth (mcpCommand.ts argumentHint is now desc|nodesc|schema; auth/noauth are stubs)
- /approval-mode: drop nonexistent --project (mode is session-only), show actual invocations, add a safety warning for auto-edit/auto/yolo
- /copy: note N = Nth-last reply (copyCommand.ts)
- tos-privacy: unify Qwen Privacy Policy URL to qwen.ai/privacypolicy
* docs: resolve review feedback — import-config args + feature-gated commands note
- /import-config: show 'all' (default source) and enumerate --scope user|project (importConfigCommand.ts)
- add a note that /workflows, /lsp, /trust register only when their feature setting is enabled (BuiltinCommandLoader.ts gates them, default off)
* docs: fix feature-gating mechanisms + restore /stats tab names
- Correct the /workflows/lsp/trust note: actual gates are QWEN_CODE_ENABLE_WORKFLOWS=1 (env),
--experimental-lsp (CLI flag), and security.folderTrust.enabled (setting) — the prior
workflowsEnabled/lsp.enabled/folderTrust keys did not exist
- /stats: restore the Session/Activity/Efficiency tab names (dashboard contents are not
documented elsewhere); keep volatile keyboard hints out per the earlier review
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
This commit is contained in:
parent
74f03bb7e6
commit
4efe2c77bc
3 changed files with 115 additions and 72 deletions
|
|
@ -96,7 +96,7 @@ This command typically compiles TypeScript to JavaScript, bundles assets, and pr
|
|||
|
||||
[Sandboxing](#sandboxing) is highly recommended and requires, at a minimum, setting `QWEN_SANDBOX=true` in your `~/.env` and ensuring a sandboxing provider (e.g. `macOS Seatbelt`, `docker`, or `podman`) is available. See [Sandboxing](#sandboxing) for details.
|
||||
|
||||
To build both the `qwen-code` CLI utility and the sandbox container, run `build:all` from the root directory:
|
||||
To build both the `qwen` CLI utility and the sandbox container, run `build:all` from the root directory:
|
||||
|
||||
```bash
|
||||
npm run build:all
|
||||
|
|
@ -112,7 +112,7 @@ To start the Qwen Code application from the source code (after building), run th
|
|||
npm start
|
||||
```
|
||||
|
||||
If you'd like to run the source build outside of the qwen-code folder, you can utilize `npm link path/to/qwen-code/packages/cli` (see: [docs](https://docs.npmjs.com/cli/v9/commands/npm-link)) to run with `qwen-code`
|
||||
If you'd like to run the source build outside of the qwen-code folder, you can utilize `npm link path/to/qwen-code/packages/cli` (see: [docs](https://docs.npmjs.com/cli/v9/commands/npm-link)) to run with `qwen`
|
||||
|
||||
### Running Tests
|
||||
|
||||
|
|
@ -257,10 +257,10 @@ Alternatively, you can use the "Launch Program" configuration in VS Code if you
|
|||
To hit a breakpoint inside the sandbox container run:
|
||||
|
||||
```bash
|
||||
DEBUG=1 qwen-code
|
||||
DEBUG=1 qwen
|
||||
```
|
||||
|
||||
**Note:** If you have `DEBUG=true` in a project's `.env` file, it won't affect qwen-code due to automatic exclusion. Use `.qwen-code/.env` files for qwen-code specific debug settings.
|
||||
**Note:** If you have `DEBUG=true` in a project's `.env` file, it won't affect `qwen` due to automatic exclusion. Use `.qwen/.env` files for `qwen`-specific debug settings.
|
||||
|
||||
### React DevTools
|
||||
|
||||
|
|
|
|||
|
|
@ -22,9 +22,9 @@ These commands help you save, restore, and summarize work progress.
|
|||
| ---------------- | ------------------------------------------------------------------------ | ------------------------------------------------------------- |
|
||||
| `/init` | Analyze current directory and create initial context file | `/init` |
|
||||
| `/summary` | Generate project summary based on conversation history | `/summary` |
|
||||
| `/compress` | Replace chat history with summary to save Tokens | `/compress` |
|
||||
| `/compress` | Replace chat history with summary to save Tokens | `/compress` or `/summarize` |
|
||||
| `/compress-fast` | Fast compression without AI — strips old tool outputs and thinking parts | `/compress-fast` |
|
||||
| `/resume` | Resume a previous conversation session | `/resume` |
|
||||
| `/resume` | Resume a previous conversation session | `/resume` or `/continue` |
|
||||
| `/recap` | Generate a one-line session recap now | `/recap` |
|
||||
| `/restore` | Revert project files to the checkpoint before a tool call ran | `/restore` (list) or `/restore <ID>` |
|
||||
| `/delete` | Delete a previous session | `/delete` |
|
||||
|
|
@ -34,21 +34,25 @@ These commands help you save, restore, and summarize work progress.
|
|||
| `/export` | Export session history to file | `/export html`, `/export md`, `/export json`, `/export jsonl` |
|
||||
| `/rename` | Rename or tag the current session | `/rename My Feature` or `/tag` |
|
||||
|
||||
> [!note]
|
||||
>
|
||||
> `/summarize` is an alias for `/compress` (it compresses chat history — a destructive operation). To generate a non-destructive project summary instead, use `/summary`.
|
||||
|
||||
### 1.2 Interface and Workspace Control
|
||||
|
||||
Commands for adjusting interface appearance and work environment.
|
||||
|
||||
| Command | Description | Usage Examples |
|
||||
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `/clear` | Clear terminal screen content | `/clear` (shortcut: `Ctrl+L`) |
|
||||
| `/clear` | Clear conversation history and free up context | `/clear`, `/reset`, `/new` |
|
||||
| `/context` | Show context window usage breakdown | `/context` |
|
||||
| → `detail` | Show per-item context usage breakdown | `/context detail` |
|
||||
| `/history` | Control history display preferences and visibility | `/history collapse-on-resume`, `/history expand-on-resume`, `/history expand-now` |
|
||||
| `/diff` | Open an interactive diff viewer showing uncommitted changes and per-turn diffs. Use ←/→ to switch between current git diff and individual conversation turns, ↑/↓ to browse files | `/diff` |
|
||||
| `/theme` | Change Qwen Code visual theme | `/theme` |
|
||||
| `/vim` | Turn input area Vim editing mode on/off | `/vim` |
|
||||
| `/voice` | Toggle voice dictation input | `/voice`, `/voice status` |
|
||||
| `/directory` | Manage multi-directory support workspace | `/dir add ./src,./tests` |
|
||||
| `/voice` | Toggle voice dictation input | `/voice`, `/voice hold`, `/voice tap`, `/voice off`, `/voice status` |
|
||||
| `/directory` | Manage multi-directory support workspace | `/dir add ./src,./tests`, `/dir show` |
|
||||
| `/cd` | Move this session to a new working directory | `/cd ../other-project` |
|
||||
| `/editor` | Open dialog to select supported editor | `/editor` |
|
||||
| `/statusline` | Open interactive [status line](./status-line.md) preset dialog | `/statusline` |
|
||||
|
|
@ -72,36 +76,52 @@ Commands specifically for controlling interface and output language.
|
|||
|
||||
Commands for managing AI tools and models.
|
||||
|
||||
| Command | Description | Usage Examples |
|
||||
| ---------------- | --------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `/mcp` | List configured MCP servers and tools | `/mcp`, `/mcp desc` |
|
||||
| `/import-config` | Import MCP servers from Claude configs | `/import-config claude-code`, `/import-config claude-desktop --scope project` |
|
||||
| `/tools` | Display currently available tool list | `/tools`, `/tools desc` |
|
||||
| `/skills` | List and run available skills | `/skills`, `/skills <name>` |
|
||||
| `/plan` | Switch to plan mode or exit plan mode | `/plan`, `/plan <task>`, `/plan exit` |
|
||||
| `/approval-mode` | Change approval mode for tool usage | `/approval-mode <mode (auto-edit)> --project` |
|
||||
| →`plan` | Analysis only, no execution | Secure review |
|
||||
| →`default` | Require approval for edits | Daily use |
|
||||
| →`auto-edit` | Automatically approve edits | Trusted environment |
|
||||
| →`auto` | Classifier-evaluated approval | Autonomous sessions with safety guardrails |
|
||||
| →`yolo` | Automatically approve all | Quick prototyping |
|
||||
| `/model` | Switch model used in current session | `/model`, `/model <model-id>` (switch immediately) |
|
||||
| `/model --fast` | Set a lighter model for prompt suggestions | `/model --fast qwen3-coder-flash` |
|
||||
| `/model --voice` | Set the model used for voice transcription | `/model --voice <model-id>` |
|
||||
| `/extensions` | List all active extensions in current session | `/extensions` |
|
||||
| `/memory` | Open the Memory Manager dialog | `/memory` |
|
||||
| `/remember` | Save a durable memory | `/remember Prefer terse responses` |
|
||||
| `/forget` | Remove matching entries from auto-memory | `/forget <query>` |
|
||||
| `/dream` | Manually run auto-memory consolidation | `/dream` |
|
||||
| `/hooks` | Manage Qwen Code hooks | `/hooks`, `/hooks list` |
|
||||
| `/permissions` | Manage permission rules | `/permissions` |
|
||||
| `/agents` | Manage subagents | `/agents manage`, `/agents create` |
|
||||
| `/arena` | Manage Arena sessions | `/arena start`, `/arena status` |
|
||||
| `/goal` | Set a goal — keep working until condition met | `/goal <condition>`, `/goal clear` |
|
||||
| `/tasks` | List background tasks | `/tasks` |
|
||||
| `/workflows` | Inspect workflow runs | `/workflows`, `/workflows <runId>` |
|
||||
| `/lsp` | Show LSP server status | `/lsp` |
|
||||
| `/trust` | Manage folder trust settings | `/trust` |
|
||||
| Command | Description | Usage Examples |
|
||||
| ---------------- | ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `/mcp` | List configured MCP servers and tools | `/mcp`, `/mcp desc`, `/mcp nodesc`, `/mcp schema` |
|
||||
| `/import-config` | Import MCP servers from Claude configs | `/import-config all`, `/import-config claude-code`, `/import-config claude-desktop --scope user\|project` |
|
||||
| `/tools` | Display currently available tool list | `/tools`, `/tools desc` |
|
||||
| `/skills` | List and run available skills | `/skills`, `/skills <name>` |
|
||||
| `/plan` | Switch to plan mode or exit plan mode | `/plan`, `/plan <task>`, `/plan exit` |
|
||||
| `/approval-mode` | Change the tool-approval mode (current session only) | `/approval-mode`, `/approval-mode auto-edit` |
|
||||
| → `plan` | Analysis only, no execution (secure review) | `/approval-mode plan` |
|
||||
| → `default` | Require approval for edits (daily use) | `/approval-mode default` |
|
||||
| → `auto-edit` | Auto-approve edits (trusted environment) | `/approval-mode auto-edit` |
|
||||
| → `auto` | Classifier-evaluated approval (autonomous) | `/approval-mode auto` |
|
||||
| → `yolo` | Auto-approve everything (quick prototyping) | `/approval-mode yolo` |
|
||||
| `/model` | Switch model used in current session | `/model`, `/model <model-id>` (switch immediately) |
|
||||
| `/model --fast` | Set a lighter model for prompt suggestions | `/model --fast qwen3-coder-flash` |
|
||||
| `/model --voice` | Set the model used for voice transcription | `/model --voice <model-id>` |
|
||||
| `/extensions` | Manage extensions | `/extensions list`, `/extensions manage` |
|
||||
| → `list` | List installed extensions | `/extensions list` |
|
||||
| → `manage` | Manage installed extensions (interactive) | `/extensions manage` |
|
||||
| → `explore` | Open extensions page in browser | `/extensions explore <Gemini\|ClaudeCode>` |
|
||||
| → `install` | Install an extension from a git repo or path | `/extensions install <repo-or-path>` |
|
||||
| `/memory` | Open the Memory Manager dialog | `/memory` |
|
||||
| `/remember` | Save a durable memory | `/remember Prefer terse responses` |
|
||||
| `/forget` | Remove matching entries from auto-memory | `/forget <query>` |
|
||||
| `/dream` | Manually run auto-memory consolidation | `/dream` |
|
||||
| `/hooks` | Manage Qwen Code hooks | `/hooks`, `/hooks list` |
|
||||
| `/permissions` | Manage permission rules | `/permissions` |
|
||||
| `/agents` | Manage subagents | `/agents manage`, `/agents create` |
|
||||
| `/arena` | Manage Arena sessions | `/arena start`, `/arena stop`, `/arena status`, `/arena select` (alias `choose`) |
|
||||
| `/goal` | Set a goal — keep working until condition met | `/goal <condition>`, `/goal clear` |
|
||||
| `/tasks` | List background tasks | `/tasks` |
|
||||
| `/workflows` | Inspect workflow runs | `/workflows`, `/workflows <runId>` |
|
||||
| `/lsp` | Show LSP server status | `/lsp` |
|
||||
| `/trust` | Manage folder trust settings | `/trust` |
|
||||
|
||||
> [!warning]
|
||||
>
|
||||
> Only install extensions (`/extensions install`) from sources you trust. Extensions can bundle MCP servers, skills, and commands that run with the same permissions as Qwen Code itself — they can access your files, API keys, and conversation data. `/extensions install` does not prompt for confirmation.
|
||||
|
||||
> [!warning]
|
||||
>
|
||||
> The `auto-edit`, `auto`, and `yolo` approval modes bypass approval prompts for tool executions. In `yolo` mode, all actions — including shell commands, file writes, and network requests — run without confirmation. Only use these modes in trusted, sandboxed, or disposable environments.
|
||||
|
||||
> [!note]
|
||||
>
|
||||
> `/workflows`, `/lsp`, and `/trust` are registered only when their feature is enabled — via the `QWEN_CODE_ENABLE_WORKFLOWS=1` env var, the `--experimental-lsp` CLI flag, and the `security.folderTrust.enabled` setting respectively. When disabled they won't appear and will report an unknown command.
|
||||
|
||||
### 1.5 Built-in Skills
|
||||
|
||||
|
|
@ -291,44 +311,54 @@ In headless (`--prompt`) or non-interactive contexts, `/diff` prints a plain-tex
|
|||
|
||||
Commands for obtaining information and performing system settings.
|
||||
|
||||
| Command | Description | Usage Examples |
|
||||
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
|
||||
| `/help` | Display help information for available commands | `/help` or `/?` |
|
||||
| `/status` | Display version information | `/status` or `/about` |
|
||||
| `/status paths` | Display current session file and log paths | `/status paths` |
|
||||
| `/stats` | Open interactive usage statistics dashboard with three tabs: Session (live metrics), Activity (heatmap, token trend, project ranking), and Efficiency (cache rate, tool leaderboard, model comparison). Use `tab` to switch tabs, `r` to cycle time ranges, `←→` to pan months, `esc` to close. | `/stats` |
|
||||
| `/stats model` | Show per-model token breakdown and estimated cost | `/stats model` |
|
||||
| `/stats tools` | Show per-tool call counts | `/stats tools` |
|
||||
| `/stats skills` | Show per-skill call counts for the current live session. This does not include cross-session daily/monthly activity. | `/stats skills` |
|
||||
| `/settings` | Open settings editor | `/settings` |
|
||||
| `/auth` | Change authentication method | `/auth` |
|
||||
| `/doctor` | Run installation and environment diagnostics | `/doctor`, `/doctor memory` |
|
||||
| `/docs` | Open full Qwen Code documentation in browser | `/docs` |
|
||||
| `/ide` | Manage IDE integration | `/ide status`, `/ide install` |
|
||||
| `/insight` | Generate programming insights from chat history | `/insight` |
|
||||
| `/setup-github` | Set up GitHub Actions | `/setup-github` |
|
||||
| `/bug` | Submit issue about Qwen Code | `/bug Button click unresponsive` |
|
||||
| `/copy` | Copy AI output to clipboard (`/copy N` = Nth-last AI message) | `/copy` or `/copy 2` |
|
||||
| `/quit` | Exit Qwen Code immediately | `/quit` or `/exit` |
|
||||
| Command | Description | Usage Examples |
|
||||
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- |
|
||||
| `/help` | Display help information for available commands | `/help` or `/?` |
|
||||
| `/status` | Display version information | `/status` or `/about` |
|
||||
| `/status paths` | Display current session file and log paths | `/status paths` |
|
||||
| `/stats` | Open the interactive usage statistics dashboard (Session, Activity, and Efficiency tabs) | `/stats` or `/usage` |
|
||||
| `/stats model` | Show per-model token breakdown and estimated cost | `/stats model` |
|
||||
| `/stats tools` | Show per-tool call counts | `/stats tools` |
|
||||
| `/stats skills` | Show per-skill call counts for the current live session (live only; excludes cross-session daily/monthly activity) | `/stats skills` |
|
||||
| `/stats daily` | Show daily token usage statistics | `/stats daily` (alias `day`), `/stats day [YYYY-MM-DD]` |
|
||||
| `/stats monthly` | Show monthly token usage statistics | `/stats monthly` (alias `month`), `/stats month [YYYY-MM]` |
|
||||
| `/stats export` | Export usage statistics to CSV or JSON | `/stats export <daily\|monthly> [date\|month] [--format csv\|json] [--output path]` |
|
||||
| `/settings` | Open settings editor | `/settings` |
|
||||
| `/auth` | Change authentication method | `/auth`, `/connect`, `/login` |
|
||||
| `/doctor` | Run installation and environment diagnostics | `/doctor`, `/doctor memory` |
|
||||
| → `memory` | Show current process memory diagnostics | `/doctor memory [--json] [--sample] [--snapshot]` |
|
||||
| → `cpu-profile` | Record a CPU profile for Chrome DevTools analysis | `/doctor cpu-profile [--duration <seconds>]` |
|
||||
| → `rollback` | Roll back the standalone CLI binary to the previous version (standalone installs only; for conversation history use `/rewind`) | `/doctor rollback` |
|
||||
| `/docs` | Open full Qwen Code documentation in browser | `/docs` |
|
||||
| `/ide` | Manage IDE integration | `/ide status`, `/ide install`, `/ide enable`, `/ide disable` |
|
||||
| `/insight` | Generate programming insights from chat history | `/insight` |
|
||||
| `/setup-github` | Set up GitHub Actions | `/setup-github` |
|
||||
| `/bug` | Submit issue about Qwen Code | `/bug Button click unresponsive` |
|
||||
| `/copy` | Copy to clipboard: reply (Nth-last), code (by lang), LaTeX, or Mermaid | `/copy`, `/copy 2`, `/copy python`, `/copy latex`, `/copy mermaid` |
|
||||
| `/quit` | Exit Qwen Code immediately | `/quit` or `/exit` |
|
||||
|
||||
> [!warning]
|
||||
>
|
||||
> `/doctor memory --snapshot` writes a V8 heap snapshot that may contain prompts, file contents, API keys, and tool results from the current session. Review the file before sharing it.
|
||||
|
||||
### 1.10 Common Shortcuts
|
||||
|
||||
| Shortcut | Function | Note |
|
||||
| ------------------ | ----------------------- | ---------------------- |
|
||||
| `Ctrl/cmd+L` | Clear screen | Equivalent to `/clear` |
|
||||
| `Ctrl/cmd+T` | Toggle tool description | MCP tool management |
|
||||
| `Ctrl/cmd+C`×2 | Exit confirmation | Secure exit mechanism |
|
||||
| `Ctrl/cmd+Z` | Undo input | Text editing |
|
||||
| `Ctrl/cmd+Shift+Z` | Redo input | Text editing |
|
||||
| Shortcut | Function | Note |
|
||||
| ------------------ | ----------------------- | ------------------------------------------------------------------------- |
|
||||
| `Ctrl/cmd+L` | Clear screen | Clears the visible screen only (does not reset the session like `/clear`) |
|
||||
| `Ctrl/cmd+T` | Toggle tool description | MCP tool management |
|
||||
| `Ctrl/cmd+C`×2 | Exit confirmation | Secure exit mechanism |
|
||||
| `Ctrl/cmd+Z` | Undo input | Text editing |
|
||||
| `Ctrl/cmd+Shift+Z` | Redo input | Text editing |
|
||||
|
||||
### 1.11 Authentication Commands
|
||||
|
||||
Use `/auth` inside a Qwen Code session to configure authentication. Use `/doctor` to inspect the current authentication and environment status.
|
||||
|
||||
| Command | Description |
|
||||
| --------- | ------------------------------------------ |
|
||||
| `/auth` | Configure authentication interactively |
|
||||
| `/doctor` | Show authentication and environment checks |
|
||||
| Command | Description |
|
||||
| --------- | ---------------------------------------------------------------------- |
|
||||
| `/auth` | Configure authentication interactively (aliases: `/connect`, `/login`) |
|
||||
| `/doctor` | Show authentication and environment checks |
|
||||
|
||||
> [!note]
|
||||
>
|
||||
|
|
|
|||
|
|
@ -4,11 +4,12 @@ Qwen Code is an open-source AI coding assistant tool maintained by the Qwen Code
|
|||
|
||||
## How to determine your authentication method
|
||||
|
||||
Qwen Code supports three authentication methods to access AI models. Your authentication method determines which terms of service and privacy policies apply to your usage:
|
||||
Qwen Code supports four authentication methods to access AI models. Your authentication method determines which terms of service and privacy policies apply to your usage:
|
||||
|
||||
1. **Qwen OAuth** — Log in with your qwen.ai account (free tier discontinued 2026-04-15)
|
||||
2. **Alibaba Cloud Coding Plan** — Use an API key from Alibaba Cloud
|
||||
3. **API Key** — Bring your own API key
|
||||
4. **Vertex AI** — Use Google Cloud Vertex AI
|
||||
|
||||
For each authentication method, different Terms of Service and Privacy Notices may apply depending on the underlying service provider.
|
||||
|
||||
|
|
@ -17,6 +18,7 @@ For each authentication method, different Terms of Service and Privacy Notices m
|
|||
| Qwen OAuth | Qwen AI | [Qwen Terms of Service](https://qwen.ai/termsservice) | [Qwen Privacy Policy](https://qwen.ai/privacypolicy) |
|
||||
| Alibaba Cloud Coding Plan | Alibaba Cloud | See [details below](#2-if-you-are-using-alibaba-cloud-coding-plan) | See [details below](#2-if-you-are-using-alibaba-cloud-coding-plan) |
|
||||
| API Key | Various Providers | Depends on your chosen API provider (OpenAI, Anthropic, etc.) | Depends on your chosen API provider |
|
||||
| Vertex AI | Google Cloud | [Google Cloud Terms](https://cloud.google.com/terms) | [Google Cloud Privacy](https://cloud.google.com/privacy) |
|
||||
|
||||
## 1. If you are using Qwen OAuth Authentication
|
||||
|
||||
|
|
@ -50,6 +52,14 @@ When you authenticate using API keys from other providers, the applicable Terms
|
|||
|
||||
Qwen Code supports various OpenAI-compatible providers. Please refer to your specific provider's terms of service and privacy policy for detailed information.
|
||||
|
||||
## 4. If you are using Vertex AI
|
||||
|
||||
When you authenticate with Google Cloud Vertex AI, the applicable Terms of Service and Privacy Notice are Google Cloud's.
|
||||
|
||||
> [!important]
|
||||
>
|
||||
> When using Vertex AI, you are subject to [Google Cloud's Terms of Service](https://cloud.google.com/terms) and [Google Cloud Privacy Notice](https://cloud.google.com/privacy), not Qwen Code's terms. Please review Google Cloud's documentation for specific details about data usage, retention, and privacy practices.
|
||||
|
||||
## Usage Statistics and Telemetry
|
||||
|
||||
Qwen Code may collect anonymous usage statistics and [telemetry](../../developers/development/telemetry) data to improve the user experience and product quality. This data collection is optional and can be controlled through configuration settings.
|
||||
|
|
@ -67,6 +77,7 @@ When enabled, Qwen Code may collect:
|
|||
- **Qwen OAuth:** Usage statistics are governed by Qwen's privacy policy. You can opt-out through Qwen Code's configuration settings.
|
||||
- **Alibaba Cloud Coding Plan:** Usage statistics are governed by Alibaba Cloud's privacy policy. You can opt-out through Qwen Code's configuration settings.
|
||||
- **API Key:** No additional data is collected by Qwen Code beyond what your chosen API provider collects.
|
||||
- **Vertex AI:** Usage statistics are governed by Google Cloud's privacy policy. No additional data is collected by Qwen Code beyond what Google Cloud collects.
|
||||
|
||||
## Frequently Asked Questions (FAQ)
|
||||
|
||||
|
|
@ -74,12 +85,14 @@ When enabled, Qwen Code may collect:
|
|||
|
||||
Whether your code, including prompts and answers, is used to train AI models depends on your authentication method and the specific AI service provider you use:
|
||||
|
||||
- **Qwen OAuth**: Data usage is governed by [Qwen's Privacy Policy](https://qwen.ai/privacy). Please refer to their policy for specific details about data collection and model training practices.
|
||||
- **Qwen OAuth**: Data usage is governed by [Qwen's Privacy Policy](https://qwen.ai/privacypolicy). Please refer to their policy for specific details about data collection and model training practices.
|
||||
|
||||
- **Alibaba Cloud Coding Plan**: Data usage is governed by Alibaba Cloud's privacy policy. Please refer to their policy for specific details about data collection and model training practices.
|
||||
|
||||
- **API Key**: Data usage depends entirely on your chosen API provider. Each provider has their own data usage policies. Please review the privacy policy and terms of service of your specific provider.
|
||||
|
||||
- **Vertex AI**: Data usage is governed by [Google Cloud's Terms of Service](https://cloud.google.com/terms) and [Privacy Notice](https://cloud.google.com/privacy). Please review Google Cloud's policies for specific details about data collection and model training practices.
|
||||
|
||||
**Important**: Qwen Code itself does not use your prompts, code, or responses for model training. Any data usage for training purposes would be governed by the policies of the AI service provider you authenticate with.
|
||||
|
||||
### 2. What are Usage Statistics and what does the opt-out control?
|
||||
|
|
@ -103,7 +116,7 @@ The Usage Statistics setting only controls data collection by Qwen Code itself.
|
|||
|
||||
### 3. How do I switch between authentication methods?
|
||||
|
||||
You can switch between Qwen OAuth, Alibaba Cloud Coding Plan, and your own API key at any time:
|
||||
You can switch between Qwen OAuth, Alibaba Cloud Coding Plan, your own API key, and Vertex AI at any time:
|
||||
|
||||
1. **During startup**: Choose your preferred authentication method when prompted
|
||||
2. **Within the CLI**: Use the `/auth` command to reconfigure your authentication method
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue