---
title: "文档总览"
description: "从 Peri TUI 开始，完成首次设置、提交任务、查看过程与继续会话。"
---

> Documentation Index
> Fetch the complete documentation index at: https://konghayao.github.io/peri-cool/llms.txt
> Use this file to discover all available pages before exploring further.

# 文档总览

Peri 的主要产品界面是 TUI。第一次使用不需要先理解配置文件，也不需要手写环境变量。安装后进入一个可回滚的项目目录，启动 Peri，跟着屏幕完成设置即可。

## 第一次使用

1. [安装 Peri](/peri-cool/docs/get-started/installation/)：安装终端程序并确认 `peri --version` 可运行。
2. [在 TUI 中快速上手](/peri-cool/docs/get-started/quickstart/)：启动界面、完成设置、选择模型并提交第一个任务。
3. [认识 TUI](/peri-cool/docs/guides/tui-navigation/)：理解消息区、输入区、状态栏和常用面板。

## 在 TUI 里完成日常操作

- [连接模型服务](/peri-cool/docs/guides/providers/)：首次向导、`/login` Provider 管理和 `/model` 模型选择。
- [会话管理](/peri-cool/docs/guides/sessions/)：新建、继续、恢复、压缩或回退会话。
- [权限系统](/peri-cool/docs/features/permissions/)：理解审批模式，以及它与系统沙箱的区别。
- [图片输入](/peri-cool/docs/features/image-input/)：把截图或本地图片交给 Peri。
- [MCP 服务器](/peri-cool/docs/features/mcp/)：查看外部工具连接状态。

## 按任务查找

- [探索陌生代码库](/peri-cool/docs/features/explore-codebase/)
- [修复缺陷](/peri-cool/docs/features/fix-bugs/)
- [实现功能](/peri-cool/docs/features/implement-feature/)
- [编写测试](/peri-cool/docs/features/write-tests/)
- [并行推进多个独立任务](/peri-cool/docs/features/parallel-work/)

## 高级参考

- [Settings 参考](/peri-cool/docs/reference/settings/)：给自动化、审计和手动恢复使用，不是首次设置主路径。
- [命令参考](/peri-cool/docs/features/cli-reference/)：CLI 参数与斜杠入口。
- [非交互模式](/peri-cool/docs/guides/non-interactive/)：在 shell 或 CI 中运行一次性任务。
- [凭据与权限边界](/peri-cool/docs/security/secrets-and-permissions/)：密钥存储、审批和安装信任边界。
- [开发者入口](/peri-cool/docs/developer/)：从权威设计、架构契约和代码索引进入仓库。
- [设计入口](/peri-cool/docs/design/)：面向贡献者的已批准设计、状态语义与阅读路径。
- [总体架构](/peri-cool/docs/design/architecture/)：层职责、依赖方向、生命周期与演进状态。

想理解 Peri 怎样建成、适合做什么、研究发现了什么或最近发生了什么，请前往[文章总览](/peri-cool/posts/)。

Source: https://konghayao.github.io/peri-cool/docs/index.mdx