Skip to content

INSTALL.md

Latest commit

 

History

History
127 lines (84 loc) · 4.32 KB

INSTALL.md

File metadata and controls

127 lines (84 loc) · 4.32 KB

Install agent-basic-skill

这个仓库里的每个 skills/<skill-name>/ 目录都是独立安装单元。安装或更新时，优先使用顶层安装器，它会在复制 skill 目录前先处理 wrapper 所需的外部依赖仓。

推荐方式

安装单个 skill：

python scripts/install_skill.py BetterGPT

安装带外部工具仓的 wrapper：

python scripts/install_skill.py bilibili-up-digest shuiyuan-cache-skill video-note-render-pdf-v0 video-note-render-pdf-v1 video-note-render-pdf-v2

安装器的行为：

  • 先读取 skills/<skill-name>/external-repos.json
  • 按 env var -> local override -> default_detect_paths -> default_clone_dir 检查外部仓
  • 已存在合法仓时跳过 clone
  • 仓缺失时自动 clone 到 default_clone_dir
  • ~/.codex/skills/<skill-name>/ 已存在时，视为受管安装副本并整体替换

如果你也要同步本仓附带的 local agents，再执行：

mkdir -p "$HOME/.codex/agents"
rsync -a agents/ "$HOME/.codex/agents/"

仍可手动覆盖安装

如果你明确知道外部仓已经准备好，也可以继续手动覆盖：

mkdir -p "$HOME/.codex/skills/BetterGPT"
rsync -a --delete skills/BetterGPT/ "$HOME/.codex/skills/BetterGPT/"

刷新全部 skills：

mkdir -p "$HOME/.codex/skills"
rsync -a --delete skills/ "$HOME/.codex/skills/"

同步全部 local agents：

mkdir -p "$HOME/.codex/agents"
rsync -a agents/ "$HOME/.codex/agents/"

rsync -a --delete 的含义是：

  • 保留目录结构与文件权限
  • 覆盖已存在文件
  • 删除目标目录里已经不再存在于仓库中的旧文件

Wrapper skill 的外部仓准备

bilinote-video-note、paperflow-pipeline-notes、shuiyuan-cache-skill、bilibili-up-digest、video-note-render-pdf-v0、video-note-render-pdf-v1、video-note-render-pdf-v2 这几个 skill 只包含入口文档和桥接脚本；真正的工具仓仍应单独放在本机，例如 ~/Desktop/src/...。

推荐把本机 source override 放在：

mkdir -p "$HOME/.codex/state/agent-basic-skill"
cp local/source-overrides.example.json \
  "$HOME/.codex/state/agent-basic-skill/source-overrides.json"

然后根据实际 clone 路径修改，并导出：

export AGENT_BASIC_SKILL_SOURCE_OVERRIDES="$HOME/.codex/state/agent-basic-skill/source-overrides.json"

如果你就是在这个仓库里维护 skills，也可以改用被 .gitignore 忽略的 local/source-overrides.json。

video-note-render-pdf-v0 / video-note-render-pdf-v1 / video-note-render-pdf-v2 额外需要：

  • repo:WncFht/video-note-pipeline
  • workspace:video-notes

默认分别回退到 ~/Desktop/src/video-note-pipeline 与该 runtime repo 下的 .local/workspaces/video-notes。

为什么不要只复制 SKILL.md

这个仓库里的部分 skill 不是单文件：

  • jupyter-notebook 依赖模板、参考文档和脚手架脚本
  • deepresearch-skill 依赖 LaTeX 模板、agent 元数据和多模态取证参考文档
  • report-download 依赖 Python 脚本和 pyproject.toml
  • frontend-slides 依赖 companion markdown、CSS 和脚本
  • frontend-style-mimic 依赖 style pack 模板、参考文档和管理脚本
  • 几个 wrapper skill 依赖路径解析脚本、参考文档和 external-repos.json

video-note-render-pdf-v0、video-note-render-pdf-v1 和 video-note-render-pdf-v2 都还需要一个独立的 runtime repo 和一个本地 case workspace；安装器只负责准备或检查 runtime repo，不会在 skill 目录里创建案例工作区。

所以安装时应始终复制整个 skills/<skill-name>/ 目录。

agents/*.toml 不走 skill 安装器；它们应作为独立的本地 agent 配置直接同步到 ~/.codex/agents/。

GitHub 安装方式

如果这个仓库发布到 GitHub，推荐继续按“整个 skill 目录”安装，而不是只取一个原始文件。

先设置 CODEX_HOME：

export CODEX_HOME="${CODEX_HOME:-$HOME/.codex}"

安装单个 skill：

python "$CODEX_HOME/skills/.system/skill-installer/scripts/install-skill-from-github.py" \
  --repo <owner>/agent-basic-skill \
  --path skills/BetterGPT

安装多个 skill 时，把多个 --path skills/<skill-name> 依次传入即可。

如果仓库中的 local agents 也要一并启用，还需额外把 agents/ 同步到 $CODEX_HOME/agents/。