用途:orient 为 learning-opportunities 技能生成仓库专属的 orientation.md 资源文件,供该技能以 orient 参数运行时,对代码库新人执行结构化学习练习。需在用户明确要求仓库导览时直接调用。
目标路径:始终写在项目级。Codex 写入 .codex/skills/learning-opportunities/resources/orientation.md;Claude Code 写入 .claude/skills/learning-opportunities/resources/orientation.md,均相对当前工作目录。目录不存在则创建;已存在则保留原内容,只写 orientation.md。
默认流程:一、检测主语言,按清单文件判断,如 Python(pyproject.toml、requirements.txt 等)、TypeScript(package.json + tsconfig.json)、Go(go.mod)、Rust(Cargo.toml)等,并完整读取主清单。二、探索仓库:读 README 与 docs;运行 find . -maxdepth 3 -not -path '/.git/' -not -path '/node_modules/' -not -path '/pycache/' -not -path '/.venv/' 看目录结构;按语言读入口点;读 2–3 个测试文件;读 5–8 个核心模块顶层结构;可选查看 git log --oneline -20 等。三、按固定结构写 orientation.md:一句话用途、主语言、流程阶段、关键文件、核心概念、常见坑、恰好 2 个导览练习、所查资料。四、向用户说明写入位置、关键文件与概念数量、如何以 orient 参数调用,以及可随时重跑更新。
showboat 模式:参数为 showboat 时改走此路径。先运行 command -v uv 检查,未安装则提示从 https://docs.astral.sh/uv/getting-started/installation/ 安装并停止。随后读仓库并规划含标题、目录、评述、代码清单附录和 2 个练习的线性走读文档,用 uvx showboat --help 了解命令,依次用 uvx showboat init、uvx showboat note、uvx showboat exec 构建,最后运行 uvx showboat verify 校验。
限制:规范中明确不得触发的情形需遵循原说明;showboat 模式依赖 uv;未提供具体支持的仓库规模、平台或性能信息。