mirror of
https://github.com/QwenLM/qwen-code.git
synced 2025-12-19 09:33:53 +00:00
docs: improve formatting and link corrections in settings documentation
This commit is contained in:
joeytoday
@@ -74,7 +74,7 @@ Qwen Code uses JSON settings files for persistent configuration. There are four
|
|||||||
|
|
||||||
In addition to a project settings file, a project's `.qwen` directory can contain other project-specific files related to Qwen Code's operation, such as:
|
In addition to a project settings file, a project's `.qwen` directory can contain other project-specific files related to Qwen Code's operation, such as:
|
||||||
|
|
||||||
- [Custom sandbox profiles](users/features/sandbox) (e.g., `.qwen/sandbox-macos-custom.sb`, `.qwen/sandbox.Dockerfile`).
|
- [Custom sandbox profiles](/users/features/sandbox) (e.g. `.qwen/sandbox-macos-custom.sb`, `.qwen/sandbox.Dockerfile`).
|
||||||
|
|
||||||
### Available settings in `settings.json`
|
### Available settings in `settings.json`
|
||||||
|
|
||||||
@@ -98,21 +98,21 @@ Settings are organized into categories. All settings should be placed within the
|
|||||||
|
|
||||||
#### ui
|
#### ui
|
||||||
|
|
||||||
| Setting | Type | Description | Default |
|
| Setting | Type | Description | Default |
|
||||||
| ---------------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
|
| ---------------------------------------- | ---------------- | ------------------------------------------------------------ | ----------- |
|
||||||
| `ui.theme` | string | The color theme for the UI. See [Themes](users/configuration/themes) for available options. | `undefined` |
|
| `ui.theme` | string | The color theme for the UI. See [Themes](/users/configuration/themes) for available options. | `undefined` |
|
||||||
| `ui.customThemes` | object | Custom theme definitions. | `{}` |
|
| `ui.customThemes` | object | Custom theme definitions. | `{}` |
|
||||||
| `ui.hideWindowTitle` | boolean | Hide the window title bar. | `false` |
|
| `ui.hideWindowTitle` | boolean | Hide the window title bar. | `false` |
|
||||||
| `ui.hideTips` | boolean | Hide helpful tips in the UI. | `false` |
|
| `ui.hideTips` | boolean | Hide helpful tips in the UI. | `false` |
|
||||||
| `ui.hideBanner` | boolean | Hide the application banner. | `false` |
|
| `ui.hideBanner` | boolean | Hide the application banner. | `false` |
|
||||||
| `ui.hideFooter` | boolean | Hide the footer from the UI. | `false` |
|
| `ui.hideFooter` | boolean | Hide the footer from the UI. | `false` |
|
||||||
| `ui.showMemoryUsage` | boolean | Display memory usage information in the UI. | `false` |
|
| `ui.showMemoryUsage` | boolean | Display memory usage information in the UI. | `false` |
|
||||||
| `ui.showLineNumbers` | boolean | Show line numbers in code blocks in the CLI output. | `true` |
|
| `ui.showLineNumbers` | boolean | Show line numbers in code blocks in the CLI output. | `true` |
|
||||||
| `ui.showCitations` | boolean | Show citations for generated text in the chat. | `true` |
|
| `ui.showCitations` | boolean | Show citations for generated text in the chat. | `true` |
|
||||||
| `enableWelcomeBack` | boolean | Show welcome back dialog when returning to a project with conversation history. When enabled, Qwen Code will automatically detect if you're returning to a project with a previously generated project summary (`.qwen/PROJECT_SUMMARY.md`) and show a dialog allowing you to continue your previous conversation or start fresh. This feature integrates with the `/summary` command and quit confirmation dialog. | `true` |
|
| `enableWelcomeBack` | boolean | Show welcome back dialog when returning to a project with conversation history. When enabled, Qwen Code will automatically detect if you're returning to a project with a previously generated project summary (`.qwen/PROJECT_SUMMARY.md`) and show a dialog allowing you to continue your previous conversation or start fresh. This feature integrates with the `/summary` command and quit confirmation dialog. | `true` |
|
||||||
| `ui.accessibility.disableLoadingPhrases` | boolean | Disable loading phrases for accessibility. | `false` |
|
| `ui.accessibility.disableLoadingPhrases` | boolean | Disable loading phrases for accessibility. | `false` |
|
||||||
| `ui.accessibility.screenReader` | boolean | Enables screen reader mode, which adjusts the TUI for better compatibility with screen readers. | `false` |
|
| `ui.accessibility.screenReader` | boolean | Enables screen reader mode, which adjusts the TUI for better compatibility with screen readers. | `false` |
|
||||||
| `ui.customWittyPhrases` | array of strings | A list of custom phrases to display during loading states. When provided, the CLI will cycle through these phrases instead of the default ones. | `[]` |
|
| `ui.customWittyPhrases` | array of strings | A list of custom phrases to display during loading states. When provided, the CLI will cycle through these phrases instead of the default ones. | `[]` |
|
||||||
|
|
||||||
#### ide
|
#### ide
|
||||||
|
|
||||||
@@ -399,9 +399,9 @@ Arguments passed directly when running the CLI can override other configurations
|
|||||||
| `--model` | `-m` | Specifies the Qwen model to use for this session. | Model name | Example: `npm start -- --model qwen3-coder-plus` |
|
| `--model` | `-m` | Specifies the Qwen model to use for this session. | Model name | Example: `npm start -- --model qwen3-coder-plus` |
|
||||||
| `--prompt` | `-p` | Used to pass a prompt directly to the command. This invokes Qwen Code in a non-interactive mode. | Your prompt text | For scripting examples, use the `--output-format json` flag to get structured output. |
|
| `--prompt` | `-p` | Used to pass a prompt directly to the command. This invokes Qwen Code in a non-interactive mode. | Your prompt text | For scripting examples, use the `--output-format json` flag to get structured output. |
|
||||||
| `--prompt-interactive` | `-i` | Starts an interactive session with the provided prompt as the initial input. | Your prompt text | The prompt is processed within the interactive session, not before it. Cannot be used when piping input from stdin. Example: `qwen -i "explain this code"` |
|
| `--prompt-interactive` | `-i` | Starts an interactive session with the provided prompt as the initial input. | Your prompt text | The prompt is processed within the interactive session, not before it. Cannot be used when piping input from stdin. Example: `qwen -i "explain this code"` |
|
||||||
| `--output-format` | `-o` | Specifies the format of the CLI output for non-interactive mode. | `text`, `json`, `stream-json` | `text`: (Default) The standard human-readable output. `json`: A machine-readable JSON output emitted at the end of execution. `stream-json`: Streaming JSON messages emitted as they occur during execution. For structured output and scripting, use the `--output-format json` or `--output-format stream-json` flag. See [Headless Mode](https://qwenlm.github.io/qwen-code-docs/en/cli/features/headless) for detailed information. |
|
| `--output-format` | `-o` | Specifies the format of the CLI output for non-interactive mode. | `text`, `json`, `stream-json` | `text`: (Default) The standard human-readable output. `json`: A machine-readable JSON output emitted at the end of execution. `stream-json`: Streaming JSON messages emitted as they occur during execution. For structured output and scripting, use the `--output-format json` or `--output-format stream-json` flag. See [Headless Mode](/users/features/headless) for detailed information. |
|
||||||
| `--input-format` | | Specifies the format consumed from standard input. | `text`, `stream-json` | `text`: (Default) Standard text input from stdin or command-line arguments. `stream-json`: JSON message protocol via stdin for bidirectional communication. Requirement: `--input-format stream-json` requires `--output-format stream-json` to be set. When using `stream-json`, stdin is reserved for protocol messages. See [Headless Mode](users/features/headless) for detailed information. |
|
| `--input-format` | | Specifies the format consumed from standard input. | `text`, `stream-json` | `text`: (Default) Standard text input from stdin or command-line arguments. `stream-json`: JSON message protocol via stdin for bidirectional communication. Requirement: `--input-format stream-json` requires `--output-format stream-json` to be set. When using `stream-json`, stdin is reserved for protocol messages. See [Headless Mode](/users/features/headless) for detailed information. |
|
||||||
| `--include-partial-messages` | | Include partial assistant messages when using `stream-json` output format. When enabled, emits stream events (message_start, content_block_delta, etc.) as they occur during streaming. | | Default: `false`. Requirement: Requires `--output-format stream-json` to be set. See [Headless Mode](users/features/headless) for detailed information about stream events. |
|
| `--include-partial-messages` | | Include partial assistant messages when using `stream-json` output format. When enabled, emits stream events (message_start, content_block_delta, etc.) as they occur during streaming. | | Default: `false`. Requirement: Requires `--output-format stream-json` to be set. See [Headless Mode](/users/features/headless) for detailed information about stream events. |
|
||||||
| `--sandbox` | `-s` | Enables sandbox mode for this session. | | |
|
| `--sandbox` | `-s` | Enables sandbox mode for this session. | | |
|
||||||
| `--sandbox-image` | | Sets the sandbox image URI. | | |
|
| `--sandbox-image` | | Sets the sandbox image URI. | | |
|
||||||
| `--debug` | `-d` | Enables debug mode for this session, providing more verbose output. | | |
|
| `--debug` | `-d` | Enables debug mode for this session, providing more verbose output. | | |
|
||||||
@@ -409,7 +409,7 @@ Arguments passed directly when running the CLI can override other configurations
|
|||||||
| `--help` | `-h` | Displays help information about command-line arguments. | | |
|
| `--help` | `-h` | Displays help information about command-line arguments. | | |
|
||||||
| `--show-memory-usage` | | Displays the current memory usage. | | |
|
| `--show-memory-usage` | | Displays the current memory usage. | | |
|
||||||
| `--yolo` | | Enables YOLO mode, which automatically approves all tool calls. | | |
|
| `--yolo` | | Enables YOLO mode, which automatically approves all tool calls. | | |
|
||||||
| `--approval-mode` | | Sets the approval mode for tool calls. | `plan`, `default`, `auto-edit`, `yolo` | Supported modes: `plan`: Analyze only—do not modify files or execute commands. `default`: Require approval for file edits or shell commands (default behavior). `auto-edit`: Automatically approve edit tools (edit, write_file) while prompting for others. `yolo`: Automatically approve all tool calls (equivalent to `--yolo`). Cannot be used together with `--yolo`. Use `--approval-mode=yolo` instead of `--yolo` for the new unified approach. Example: `qwen --approval-mode auto-edit`<br>See more about [Approval Mode](users/features/approval-mode). |
|
| `--approval-mode` | | Sets the approval mode for tool calls. | `plan`, `default`, `auto-edit`, `yolo` | Supported modes: `plan`: Analyze only—do not modify files or execute commands. `default`: Require approval for file edits or shell commands (default behavior). `auto-edit`: Automatically approve edit tools (edit, write_file) while prompting for others. `yolo`: Automatically approve all tool calls (equivalent to `--yolo`). Cannot be used together with `--yolo`. Use `--approval-mode=yolo` instead of `--yolo` for the new unified approach. Example: `qwen --approval-mode auto-edit`<br>See more about [Approval Mode](/users/features/approval-mode). |
|
||||||
| `--allowed-tools` | | A comma-separated list of tool names that will bypass the confirmation dialog. | Tool names | Example: `qwen --allowed-tools "Shell(git status)"` |
|
| `--allowed-tools` | | A comma-separated list of tool names that will bypass the confirmation dialog. | Tool names | Example: `qwen --allowed-tools "Shell(git status)"` |
|
||||||
| `--telemetry` | | Enables [telemetry](/developers/development/telemetry). | | |
|
| `--telemetry` | | Enables [telemetry](/developers/development/telemetry). | | |
|
||||||
| `--telemetry-target` | | Sets the telemetry target. | | See [telemetry](/developers/development/telemetry) for more information. |
|
| `--telemetry-target` | | Sets the telemetry target. | | See [telemetry](/developers/development/telemetry) for more information. |
|
||||||
|
|||||||
Reference in New Issue
Block a user