# cyac（赛亚克）使用说明

欢迎使用 cyac（赛亚克）。本文档是 **cyac-v0.1.0-windows-x64.zip** 的完整使用指南。

---

## 一、cyac 是什么

cyac（赛亚克，Sài yà kè）是 **Ollama 生态的 CLI 优先编程入口** —— 用本地模型做 explain、refactor、diagnose、generate，在终端里完成，可脚本、可管道。

面向终端开发者，提供本地化、注重隐私的代码理解、生成与重构能力。当你想用 Ollama 做编程时，cyac 是专门为此设计的 CLI 工具。

**核心特点：**

- **Ollama 深度集成**：本地模型优先，无 API 成本，隐私安全；无本地时可选 DeepSeek API fallback
- **CLI 优先**：纯终端工作流，可脚本化、管道、CI 集成
- **适用场景**：新项目上手、代码重构、Bug 排查、测试与文档生成、日常编程问答

**功能概览：**

| 功能   | 说明                      |
| ---- | ----------------------- |
| 代码解释 | 解释指定代码段的逻辑              |
| 智能重构 | 重命名符号、提取函数，支持 `--apply` 直接修改、多文件批量修改 |
| 代码生成 | 根据描述生成函数实现，支持 `--output` 写入文件 |
| 代码搜索 | `search` 命令按关键词查找代码库        |
| 测试生成 | 基于现有代码生成单元测试            |
| 代码分析 | 复杂度分析、依赖分析              |
| 文档生成 | 生成 API 文档               |
| Bug 诊断 | 分析错误日志，支持 `--apply` 自动应用修复 |
| 跨文件引用 | 解析 import/use，自动收集相关文件上下文 |
| 交互对话 | chat 与 REPL 模式          |
| 项目会话 | 保持上下文的会话模式，支持 save 写入文件 |
| Tool Calling | `chat --tools` 启用，模型可主动 read_file、list_dir、write_file |
| Git 自动 Commit | `features.auto_commit` 开启后，写入文件自动 git add + commit |


---

## 二、文档索引


| 文档              | 说明                      |
| --------------- | ----------------------- |
| [安装指南](安装指南.md) | 解压、一键安装、验证              |
| [快速开始](快速开始.md) | 前置条件、首次使用、常用命令、配置       |
| [使用示例](使用示例.md) | 日常开发场景与完整案例             |
| [命令参考](命令参考.md) | 所有命令、选项、别名完整说明          |
| [故障诊断](故障诊断.md) | diagnose 命令、Bug 排查、常见问题 |
| [高级用法](高级用法.md) | 流式输出、--dry-run、Tool Calling、MCP、操作审计、配置  |
| [常见问题](常见问题.md) | FAQ 与解答                 |
| [功能说明](../features/README.md) | 各功能模块详细使用说明（Tool Calling、MCP、插件、记忆、Skill、多角色） |
| [品牌与命名](../品牌与命名.md) | 中文名「赛亚克」的读音、寓意与使用建议 |


---

## 三、快速导航

1. **首次使用**：阅读 [安装指南](安装指南.md) → [快速开始](快速开始.md)
2. **日常开发**：参考 [使用示例](使用示例.md) 中的场景案例
3. **命令速查**：见 [命令参考](命令参考.md) 或 [快速开始](快速开始.md) 中的「常用命令」
4. **Bug 诊断**：使用 [故障诊断](故障诊断.md) 中的 diagnose 命令
5. **高级功能**：流式输出、--dry-run、Tool Calling、审计等见 [高级用法](高级用法.md)
6. **遇到问题**：查看 [常见问题](常见问题.md)
7. **功能详解**：各功能模块（Tool Calling、MCP、插件、记忆、Skill、多角色）见 [功能说明](../features/README.md)

