> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trae.cn/llms.txt?lang=zh
> Use this file to discover all available pages before exploring further.

本文介绍 TraeCode CLI 的常见使用场景并提供示例指令，以便你在任务中熟练且灵活地使用 TraeCode CLI。

## 理解陌生代码库 {#cc093d87}

当接触一个新项目时，使用 TraeCode CLI 快速建立对代码库的整体认知。

```Plain Text
了解项目整体架构：
这个项目的整体架构是怎样的？请用目录树和文字说明。

追踪核心业务流程：
我们系统中的支付流程是怎样的？涉及到哪些关键服务和函数调用？

定位特定功能实现：
用户权限校验逻辑是在哪里实现的？

分析复杂模块设计：
给我讲讲缓存模块的设计，包括缓存策略和失效机制。
```

## 编写与修改代码 {#659d1d88}

TraeCode CLI 可以协助你开发新功能、修复漏洞、编写文档等。

```Plain Text
更新文档：
更新 README.md 文件，在功能介绍部分增加 “支持多模型切换” 的说明。

增加业务逻辑：
为订单创建接口增加一个输入参数校验，确保用户 ID 不能为空。

修复复杂问题：
在后台的 worker queue 实现中存在一个 race condition，请帮我定位并修复它。
```

## 测试与调试功能 {#e9982079}

TraeCode CLI 可以帮助你运行单元测试、定位问题并提供修复建议。

```Plain Text
运行单元测试并修复问题：
运行所有单元测试，并尝试修复那些失败的测试用例。

排查安全漏洞：
扫描代码，查找可能存在的 SQL 注入漏洞，并提供修复建议。

分析失败原因：
CI 上的构建失败了，帮我分析一下日志，找出失败的原因。
```

## 自动化 Git 操作 {#415fdc9b}

让 TraeCode CLI 帮你处理 Git 命令。

```Plain Text
快速提交：
帮我把暂存区的文件提交了，提交信息是 "feat: add user profile page"。

查询提交历史：
查找一下是哪个 commit 修改了登录页面的 UI 样式。

处理复杂的分支操作：
将我当前的分支 rebase 到 main 分支，并在过程中自动解决冲突。
```

## 在自动化脚本中使用  TraeCode CLI {#4d4787de}

TraeCode CLI 支持在非交互模式下运行。你可以便捷地将 TraeCode CLI 集成到 CI/CD 流水线或其他自动化脚本中，实现开发流程的自动化。

```Bash
## 在 CI 脚本中，根据最近的 Git 提交，自动更新 README 文件 
traecli --allowed-tool Bash,Edit,MultiEdit,Write -p "update the README with the latest changes"

## 在 CI 脚本中，自动运行一个预先编写的 Prompt 模板（将 arg1 和 arg 2 替换为实际参数）
traecli -p /command arg1 arg2
```

## 命令行参数 {#71d9dd77}

你可以使用以下命令行参数来传递额外的信息。

<!-- @cols-width: 177,685 -->
| **参数名称**  | **描述**  |
| --- | --- |
| `--add-dir`  | 允许智能体访问的额外目录。可多次指定，也可使用逗号分隔多个目录。  |
| `--allowed-tool`  | 指定自动允许使用的工具，例如 "Bash"、"Edit"、"Replace" 等。多个工具使用逗号分隔。可多次指定。  |
| `--bash-tool-timeout`  | 设置通过 Bash 工具执行的命令的最大运行时间，超时后将自动终止执行，例如 `30s`、`5m`、`1h`。  |
| `-c` / `--config`  | 以 “k=v“ 形式覆盖设置。  |
| `-d` / `--debug     `  | 启用调试模式 —— 输出 DEBUG 级别日志。  |
| `--disallowed-tools`  | 指定自动禁用的工具。多个工具使用逗号分隔。可多次指定。  |
| `-h` / `--help`  | 获取 TraeCode CLI 的使用帮助。  |
| `--json`  | 以 JSON 格式输出完整信息，包括 System Prompt、工具调用、执行过程与最终结果。仅与 `--print` 配合使用。  |
| `-p` / `--print`  | 打印响应内容并立即退出，适用于管道（pipes）场景。  |
| `--query-timeout`  | 设置单次查询的最大执行时长，超时将终止查询，例如 `30s`、`5m`、`1h`。  |
| `--resume`  | 通过 ID 恢复一个会话；如果未提供 ID，则自动恢复最近一次会话。  |
| `--session-id`  | 使用指定的会话 ID 进行会话跟踪。  |
| `-v` / `--version`  | 查看 TraeCode CLI 的当前版本。  |
| `-w` / `--worktree`  | 在隔离的 Git worktree 中启动任务（名称为可选设置；若省略则自动生成一个名称）。  |
| `-y` / `--yolo`  | 启用 YOLO 模式 —— 跳过工具权限检查。  |