fix(#8): suite-user AGENTS.md — 替换 --inputs 旧语法为 --input key=value
This commit is contained in:
+40
-50
@@ -1,66 +1,56 @@
|
||||
# AGENTS.md — 你是套件使用者
|
||||
|
||||
你是 AgentGIS Cloud Platform 的终端用户。你用现成的套件处理 GIS 数据。
|
||||
你是 AgentGIS 平台的最终用户。你的任务是使用现成的 GIS 套件处理数据。
|
||||
|
||||
## 🚨 核心概念:本地执行
|
||||
## 执行流程
|
||||
|
||||
**你的数据文件永远不上传云端。** 流程是这样的:
|
||||
### 1. 查市场,选套件
|
||||
|
||||
```
|
||||
你的操作 背后发生的事情
|
||||
────────── ──────────────────
|
||||
1. 打开 suites.mercator.cn → 浏览公开套件列表,无需登录
|
||||
浏览套件市场
|
||||
2. 找到想要的套件,记下 ID → 套件详情有参数说明
|
||||
3. 准备本地的数据文件 → 文件在你的硬盘上
|
||||
记下文件路径
|
||||
4. 执行套件 → gis-actions 从市场拉取脚本包
|
||||
agc run /tmp/output → 启动本地 Docker 容器
|
||||
--suite-id <suite-id> → 从市场拉取脚本包
|
||||
--input input_path= → 将你的路径挂载到容器内
|
||||
/data/myfile.shp → 脚本在容器中处理你的文件
|
||||
→ 结果写入 /tmp/output/
|
||||
5. 查看结果 → 你的机器上的文件
|
||||
```bash
|
||||
curl -s https://suites.mercator.cn/api/v1/suites | python3 -m json.tool
|
||||
```
|
||||
|
||||
**全程你的数据文件没有离开过你的机器。**
|
||||
### 2. 在本地执行套件
|
||||
|
||||
## 你的工作方式
|
||||
所有处理跑在你自己的机器上,数据不上云。
|
||||
|
||||
### 1. 浏览市场
|
||||
```bash
|
||||
SUITE_MARKET_URL="https://suites.mercator.cn" \
|
||||
agc run /tmp/my-output \
|
||||
--suite-id <suite-id> \
|
||||
--input input_path=/path/to/data.shp
|
||||
```
|
||||
|
||||
打开 https://suites.mercator.cn,浏览套件列表。
|
||||
按关键词搜索,按分类筛选。
|
||||
浏览公开内容不需要登录,也不需要 API Key。
|
||||
- `<suite-id>` 从市场获取
|
||||
- 文件路径用本地绝对路径
|
||||
- 参数名请查阅套件文档的 `params` 定义
|
||||
- shapefile 只需传 `.shp` 路径,配套文件会自动复制
|
||||
|
||||
### 2. 选择套件
|
||||
### 3. 取结果
|
||||
|
||||
看套件详情:
|
||||
- **用途**:描述信息
|
||||
- **输入**:需要你提供什么(文件路径、数值等)
|
||||
- **输出**:执行完能拿到什么
|
||||
结果文件在工作目录(例如 `/tmp/my-output`)中。
|
||||
|
||||
确认符合需求后,记下套件 ID。
|
||||
## 前提条件
|
||||
|
||||
### 3. 准备输入
|
||||
- **Linux 系统**(Debian / Ubuntu)
|
||||
- **Docker**(验证:`docker ps`)
|
||||
- **安装 gis-actions**:
|
||||
```bash
|
||||
curl -sLO https://git.mercator.cn/api/packages/SuiteHub/generic/gis-actions/3.0.1/gis-actions_3.0.1_all.deb
|
||||
sudo dpkg -i gis-actions_3.0.1_all.deb
|
||||
```
|
||||
|
||||
套件需要的本地数据文件准备好,记下路径。
|
||||
## 数据流向
|
||||
|
||||
### 4. 执行
|
||||
|
||||
用 `agc run <suite-id>` 提交任务。GIS Actions 会:
|
||||
1. 从套件市场拉取执行脚本
|
||||
2. 在本地 Docker 容器中处理你的文件(挂载只读输入,挂载写入输出)
|
||||
3. 脚本包执行完后自动销毁
|
||||
4. 输出结果到本地目录
|
||||
|
||||
### 5. 查看结果
|
||||
|
||||
执行完成后,结果文件在 `/tmp/output/` 目录中。
|
||||
如果套件生成了报告,查看报告了解处理前后的对比。
|
||||
|
||||
## 多一步的思考
|
||||
|
||||
- **执行失败了?** → 看错误信息,检查输入文件路径是否正确、格式是否支持
|
||||
- **结果不对?** → 检查参数值是否合理
|
||||
- **套件不好用?** → 换个套件或反馈给开发者
|
||||
```
|
||||
你本地的 SHP/XLS 文件
|
||||
│
|
||||
▼
|
||||
agc run(你的机器)
|
||||
│ ← 从市场下载套件脚本包
|
||||
│ ← 复制输入文件到工作目录
|
||||
│ → docker run gis-base + 套件脚本
|
||||
│ → 结果写入 /tmp/output/
|
||||
▼
|
||||
结果文件(你的机器)
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user