Files
homeagent-sdk/docs/guide/getting-started.md
JianFeeeee c7e5d2a446 docs: README 补文档站入口,并把「SDK 源码」链接迁到 GitHub
SDK 仓此前**没有任何地方指向文档站** —— README 不写、GitHub 仓的
homepage 字段也是空的,于是从仓首页根本走不到 sdk.homeagent.jianfgit.xyz。
文档站本身一直在线(106 个文件的 mkdocs 产物),只是没人从仓里指过去。

本次补上:
  - README.md / README_EN.md 顶部加文档站入口(快速开始 / API 参考 / 能力边界
    / llms.txt + llms-full.txt 的 agent 直读入口),并在末尾加「文档」章节
    列出全部页面的直链。
  - mkdocs.yml 的社交链接由 gitcode 改指 GitHub,并**新增** gitcode 镜像入口与
    介绍站入口(国内直连 gitcode 更快,海外/权威源看 GitHub,两个都留)。
  - docs/guide/getting-started.md 的 `git clone` 地址改为 GitHub 仓名
    (homeagentsdk),并写明「release 附件暂时仍在 gitcode」这个事实。

★ 刻意**不**改的东西:Go 模块路径 `gitcode.com/JianFeeeee/homeagent-sdk`。
改模块路径会让所有现有插件的 go.mod 全面失效,属于破坏性变更,
与「仓库托管位置迁移」是两件事。

关于 GitHub 侧没有 release 条目(因此不能写 releases/latest/download/...,
那会 404):已在 README 里如实写明 —— 二进制目前只在 gitcode 的 release 附件里,
GitHub 从下一个 SDK 版本(v1.4.0)起才会同步发布。

验证:两份 README 里 28 个 URL 全部实测 200;文档站重建(106 文件)并部署,
线上 `git clone` 已是 GitHub 地址、旧 gitcode clone 地址 0 次、
三个社交入口名称正确。
2026-09-29 20:43:27 +08:00

2.3 KiB
Raw Blame History

环境与工具链

hmapdev 是 SDK 仓提供的统一插件开发工具链,Go 与 Lua 两种插件都用它, 最终产出 .hmap 插件包(工具名即取自这个包格式)。

!!! note "改名说明" 1.2.0 起工具链由 plugindev 更名为 hmapdev;SDK 存储目录同时由 ~/.homeagent/plugindev/sdk 迁到 ~/.homeagent/hmapdev/sdk (旧目录会自动继续沿用)。

安装

从源码构建:

git clone https://github.com/JianFeeeee/homeagentsdk
cd homeagentsdk/tools/hmapdev
go build -o hmapdev
# 把 hmapdev 放进 PATH,或直接用 ./hmapdev

也可以从 SDK 的 release 附件下载预编译二进制(hmapdev_linux_amd64 等, 共 5 个平台:linux/darwin/windows × amd64/arm64)。

仓已迁到 GitHub;gitcode 仅作国内镜像(源码同步,release 附件暂时仍在那里): https://gitcode.com/JianFeeeee/homeagent-sdk/releases。 Go 模块路径仍是 gitcode.com/JianFeeeee/homeagent-sdk —— 这是有意保留的, 改模块路径会让现有插件的 go.mod 全面失效。

SDK 版本管理

hmapdev 会维护一份本地 SDK 存储,init 时按 plg.json 里的 sdk 字段 选择版本。两者必须一致,否则编译出的插件与内核协议可能错配。

hmapdev sdk list            # 已安装的 SDK 版本
hmapdev sdk current         # 当前使用的版本
hmapdev sdk latest          # 最新可用版本
hmapdev sdk install v1.2.0  # 安装指定版本
hmapdev sdk use v1.2.0      # 切换版本
hmapdev sdk path            # 当前 SDK 路径

存储在 ~/.homeagent/hmapdev/sdk/<version>/。

!!! warning "版本未命中会明确报错" plg.json 声明的 sdk 版本若不在本地存储里,hmapdev 不会退回某个默认版本, 而是报错并让你先 hmapdev sdk install。这是有意的:静默降级会产出与内核 协议不匹配的插件,那种失败要到运行时才暴露。

源码调试

不编译直接跑插件源码,输出调用轨迹:

hmapdev debug [dir]   # dir 默认当前目录

写 Lua 插件时更简单——sdk.lua 是 SDK 模拟层,可以直接用解释器跑:

lua main.lua

下一步