Skip to content

Commit 4efe2c7

Browse files
DragonnZhangCopilot
DragonnZhang
and
Copilot
authored
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 14e6ae8 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>
1 parent 74f03bb commit 4efe2c7

3 files changed

Lines changed: 115 additions & 72 deletions

File tree

‎docs/developers/contributing.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ This command typically compiles TypeScript to JavaScript, bundles assets, and pr
9696

9797
[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.
9898

99-
To build both the `qwen-code` CLI utility and the sandbox container, run `build:all` from the root directory:
99+
To build both the `qwen` CLI utility and the sandbox container, run `build:all` from the root directory:
100100

101101
```bash
102102
npm run build:all
@@ -112,7 +112,7 @@ To start the Qwen Code application from the source code (after building), run th
112112
npm start
113113
```
114114

115-
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`
115+
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`
116116

117117
### Running Tests
118118

@@ -257,10 +257,10 @@ Alternatively, you can use the "Launch Program" configuration in VS Code if you
257257
To hit a breakpoint inside the sandbox container run:
258258

259259
```bash
260-
DEBUG=1 qwen-code
260+
DEBUG=1 qwen
261261
```
262262

263-
**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.
263+
**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.
264264

265265
### React DevTools
266266

0 commit comments

Comments
 (0)