Files
vibe-coding-cn/.github/getting-started-AGENTS.md
T

29 lines
6.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 入门文件组维护指南
## 职责
入门文件平铺在`.github/`根;原名不冲突的文件保留原名,README和AGENTS指南因重名分别命名为`getting-started-README.md`与`getting-started-AGENTS.md`。本组提供给网页版 AI 使用的 Pi CLI 安装配置提示词,以及一个独立的可选项目练习。
## 文件地图
| 文件 | 职责 |
|---|---|
| `getting-started-README.md` | 入门索引 |
| `god.md` | 《道成了肉身》:以经文题名组织,要求全文复制到网页版 Chat AI 并逐轮引导,直到本文范围内的 Pi CLI、OpenAI GPT 与本机 Bash 配置/使用验证完成 |
| `first-project.md` | 可选的本地项目闭环练习 |
| `getting-started-AGENTS.md` | 本组维护规则 |
## 修改规则
- 根`README.md`是唯一主页;`getting-started-README.md`只做导航,不复制完整教程。
- `god.md` 本身就是给网页版 Chat AI 的完整提示词:文件头要求用户全文复制并逐轮互动;网页 AI 首轮简短说明路线;系统不明时才问系统,已提供的系统/终端信息直接复用;实际终端未确认或未就绪时指导打开/确认本机终端(Android 使用 Termux;仅在 Termux 未安装时才说明其官方来源与安装影响并等待用户明确决定),若用户尚无检查结果且系统、实际终端已明确且已打开,可直接安排 M0 只读版本检查;已回报目标终端的版本号则复用证据并跳过,已回报错误则按对应错误分支处理、不重复初始检查(仅允许明确规定的条件性重试);Android/Termux 按 Pi 官方 Termux 指南引导,不套用桌面安装命令。再从 M0 引导到 M4,按需检查/安装 Pi CLI、准备网络、连接 OpenAI GPT、验证本机 Bash;若 CLI 已验证可用则跳过安装专用网络检查与安装步骤。安装阶段只核对当前安装路线所需目标,不逐项探测未触发的安装源;短网络探测须设置连接和总时限,并说明超时不等于不可达;OpenAI 模型网络检查仅在 M4.1 按所选登录路线与实际故障执行;Pi 的 OpenAI GPT 路线区分 ChatGPT 订阅 OAuth(provider `openai-codex`)和 OpenAI API Key,不得将 ChatGPT 订阅等同 API 额度;用户另选本地模型时按请求可另行指导,但不计作 OpenAI GPT 验证或满足完成标准第 2 项;仅 API Key 路线可探测 `api.openai.com`,订阅 OAuth 不用该端点代测。安装路线默认优先对应系统的官方安装器,且每轮只展示一条当前路线。必须等全部完成标准有真实证据后才报告完成,不得停在版本号、模型回答或单次命令检查。网页 AI 只核对用户回报,不能冒充本机执行。Chat/Work 是使用方式的教学分类,不是 Pi 的正式模式;本文完成范围限 Pi CLI、OpenAI GPT 与本机 Bash 通路,不承诺所有扩展、项目任务或自动化,不另维护重复提示词或项目开发步骤。
- `god.md` 使用正常 Markdown 排版,标题、段落和链接直接渲染;仅命令和对话示例保留独立代码块,不用外层围栏包住全文。整篇使用 GitHub 文件页右上角的原生全文复制按钮。移除折叠标签、HTML 锚点和页内章节链接;入站链接及历史重定向直接指向 `god.md`,文集链接不生成失效片段。修改时保留经文、操作流程、安全边界和完成标准。经文仅用已核验的《圣经》和合本简体(CUVS)原句,注明书卷、章节、版本与原页;连续节录须注明,不拼接或改写。保留原语境,技术对应另作说明,不以引用或比喻增加执行授权、权限或效果承诺。
- 安装方式、Node.js 版本要求、系统支持和 provider 流程以 Pi 当前官方文档与安装入口为准;链接及命令须明确系统、终端、影响和成功判断。官方资料未说明的内容标为未知,不猜测。
- 区分 `pi --version`、模型授权/可用和项目任务完成;不把 CLI 安装说成模型已接通或项目环境已就绪。模型授权前,M4.0 先说明目录资源加载、会话保存与信任提示的影响,再引导用户在目标终端用 `pi` 进入交互界面;`/login`、`/model` 和问题在 Pi 输入框而非系统终端或网页版 AI 输入。已有目标目录的 Pi 会话直接复用,M4.2 不要求重新启动;空目录不是沙箱。M4.1 复用目标环境、路线与模型均未变化且无新失败信号的 GPT 成功回答,不重复登录或提问;已配置但无回答时仍须实际验证,只有缺少授权或实际鉴权失败才处理登录,不能将网络超时、限额或模型不可用直接归因于凭据失效,不为常规验证退出账号、删除或覆盖凭据。
- 不把 WSL、Git、Python、编辑器、代理或项目依赖设为 Pi CLI 安装的通用前置条件。Windows 原生 Git Bash 是内置 Bash 工具的命令环境,不是 CLI 安装本身的要求。
- 可达网络是 Pi 安装/更新和 OpenAI 云端 GPT 路线的基础条件;提示词按用户选择的订阅 OAuth 或 API Key 路线确认实际目标可达,再安装或登录。普通网络可达时跳过代理;只在具体官方分发源或模型服务确实不可达时,才逐步处理网络配置。FlClash 与历史服务商注册链接仅为条件路线,须标明来源和未核验边界;注册链接不是个人订阅链接,个人订阅 URL 属于凭据,只能由用户在本机 FlClash 导入。用户选择 FlClash 路线后,默认目标配置为开启 TUN、系统代理和全局模式;启用前说明流量路由范围、隐私与网络影响、权限和恢复路径,等待用户确认;用户拒绝时不得报告该路线已完成。不默认购买服务。关闭 TLS 或使用非官方源一律不作为排障方案。
- 不要求用户把密码、API Key、Token、cookie、订阅链接、私钥、OAuth 授权链接、授权码、设备码或回调 URL 贴给网页 AI。OAuth 最终授权码或回调 URL 仅在 Pi 明确提示时贴回本机 Pi,授权链接只用于本机浏览器;给网页 AI 只回报授权状态或简短脱敏错误,不提供验证码、链接或截图。Pi 以启动账户权限运行,不是安全沙箱;提醒用户不要用管理员/root 启动并审阅实际命令与改动。
- 第一个项目保持可选且独立;只同步其真实前置条件和指向提示词的链接,不在练习中复制 Pi 安装说明。
- 入口变化时同步`.github/context/README.md`、根`README.md`、`llms.txt`、`.github/llms-full.txt`和`.github/taxonomy.yml`;删除或迁移入口时核对`.github/redirects.yml`与活动链接。
- 修改后运行 `make sync-doc-toc` 和 `make test`;本地文档检查不证明用户机器安装成功、认证有效或模型效果。